---

Dev Setup

1. Install Latest Docker
2. Install Latest Node/npm
3. Install AWS CLI v2
4. Set up the git hooks.

bin/dev setup

5. Grab the dev.env file from the notion secrets page and place it in the top level of your project.
6. Install python dependencies in the container. (You will need to do this every time new python dependencies are added.)

bin/dev py-req

7. Install Client dependencies. (You will need to do this every time new npm dependencies are added.)

bin/dev client-req

8. Install pre-commit.

bin/dev sudo pre-commit install-hooks
sudo chown -R $(id -u):$(id -g) .pre-commit

---

Running the App

1. Start Containers and start the Flask web server

bin/dev backend

2. Start the Client

bin/dev client

3. Navigate to app: http://localhost:3000

---

Testing

1. Run Backend Tests. All args are passed transparently to pytest

bin/dev run pytest [args]

2. Run Client Tests.

bin/dev jstest [files]

3. Run linters. (Runs full suite of linters on committed files - this is automatically done before git push and again by a github action during CI.)

bin/dev check

Updating

1. Occasionally, newer versions of the devobx container will be made. Your invocation of bin/dev backend will likely pull it, but you can manually do so by running.

bin/dev pull

Fix Python Location for vscode

bin/dev run bash
rm /home/worker/app/.venv/bin/python3.8 &&
cp /usr/local/bin/python3.8 /home/worker/app/.venv/bin/python3.8 &&
ln -fs /home/worker/app/.venv/bin/python3.8 /home/worker/app/.venv/bin/python