How To Start Using System as Code

Goal: Set up your machine to support System as Code. This includes editing recipes and executing semi-automated recipes.

Steps

1. Clone your team's fork of this repo; see the list of System as Code repositories.
2. Install Python if you have not already. Add it to the system path.
3. Open a new terminal in your repo dir and run the following commands:
4. What operating system are you using?

   Windows:

   1. python.exe -m pip install --upgrade pip

   Mac:

   1. python3 -m pip install --upgrade pip

5. In the same terminal run the following commands (any operating system).

   pip install pipenv
   pipenv install

6. [Placeholder. Skip this step.]
   Future behavior

   Once we have enabled executable steps, this will run verify_environment() locally, executing in the context of the associated python file.
7. Do you want to enable local development for the website?

   Yes:

   1. Accomplish the goal Enable local development

8. Done!

Enable local development

1. Install Node version 20+ if you have not already.
2. In the same terminal run the following commands.

   npm install
   npm run start

3. Wait for about 30 seconds until your terminal tells you site is running and shows a URL.
4. Press o[ENTER] in the terminal to open the site in your default browser.
5. Done!