Skip to main content

Running locally

Requirements

  1. Docker desktop
  2. NodeJs v18+

Running the project locally

  1. Extract the source code to a prefered directory and switch to this directory
    cd path/to/directory
  2. Install project npm dependencies
    npm install
  3. Create .env file by taking a copy of {PROJECT_DIR}/apps/api/.env.example -> {PROJECT_DIR}/apps/api/.env
  4. Update .env file with the environment variable values. For more details check Environment variables section.
  5. Start docker containers using the docker-compose.yml and ensure the containers have started and running
    docker compose up
  6. 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:
    pnpm dev
  7. You should be able to visit the fontend @ http://localhost:3000