Requirements
- Docker desktop
- NodeJs v18+
Running the project locally
- Extract the source code to a prefered directory and switch to this directory
- Install project npm dependencies
- Create
.env file by taking a copy of {PROJECT_DIR}/apps/api/.env.example -> {PROJECT_DIR}/apps/api/.env
- Update
.env file with the environment variable values. For more details check Environment variables section.
- Start docker containers using the
docker-compose.yml and ensure the containers have started and running
- Once the docker container are running, you can start the backend api and web frontend using turbo. From within the root of the PROJECT_DIR run:
- You should be able to visit the fontend @ http://localhost:3000