This project is cool.

1. Install Docker

2. Add the following .env file inside /api:

   env="prod"  # prod | stage | dev

3. Add an empty .env file inside /web

4. Compose up docker-compose.yaml

That's it! Go to localhost:3000 to use the interactive webapp, or localhost:8000 to try out the API.

1. Install Docker

2. Add the following .env file inside /api:

   env="dev"  # prod | stage | dev

3. Add an empty .env file inside /web

4. To enable linting inside your preferred IDE, create a Python virtual environment and install the Python dependencies. Likewise, install the JavaScript dependencies for JS linting.

   python -m venv venv
   source venv/bin/activate  # for unix
   ./venv/Scripts/activate  # for windows
   python -m pip install -r api/requirements.txt
   
   cd app
   npm install yarn
   yarn install

5. Compose up docker-compose-dev.yaml for a build with hot-reloading enabled on the webapp upon file changes

There are several tests scripts which can be called with the pytest command inside the api container. Reference the Pytest usage guide more details on running a specific test. For local usage, it is recommended to add the -v flag for verbose outputs.