Skip to content

Getting Started With The Application

Aramis Facchinetti edited this page May 4, 2024 · 2 revisions

Prerequisites

Before running the application, ensure you have the following:

  • Docker installed on your system.
  • OpenAI API key (if you plan to use the OpenAI mode).
  • Geolocation API access key
  • If you plan to run the user manager with the real AWS Cognito (to to run the mocked user manager then you can skip this step):
    • AWS cli configured, so following environment varibales set: USER_SERVICE_AWS_ACCESS_KEY_ID, USER_SERVICE_AWS_SECRET_ACCESS_KEY, USER_SERVICE_AWS_REGION
    • User pool setup in AWS Cognito, so the following environment varibales: COGNITO_CLIENT_ID, COGNITO_USER_POOL_ID, COGNITO_HOSTED_UI_BASE_URL
  • If you plan to use the image service container:
    • Set IMG_AWS_ACCESS_KEY_ID, IMG_AWS_SECRET_ACCESS_KEY with the appropriate passkeys of the AWS S3 Service
  • If you plan to use the production Google Maps API then you need the following API KEY: REACT_APP_GOOGLE_MAPS_API_KEY

How to start

Constant response mode

  1. Go to root directory

  2. Type:

    docker compose up
  3. Access the application

    http://localhost:8000

OpenAI mode (requires OpenAI api Key)

  1. Go to root directory

  2. Insert the OPENAI_API_KEY environment variable in the .env file

  3. Type:

    docker compose -f docker-compose-real-llm.yaml up
  4. Access the application

    http://localhost:8000

Constant response

  1. Go to root directory

  2. Type:

    docker compose -f docker-compose-with-user-manager.yaml up
  3. Access the application

    http://localhost:8000

All services in production mode

  1. Go to root directory

  2. Insert the following environment variables in the .env file:

    • OPENAI_API_KEY
  3. Type:

    docker compose -f docker-compose-real-llm-with-user-manager.yaml up
  4. Access the application

    http://localhost:8000

Clone this wiki locally