local_setup.md

Follow this steps to set up your local environment for development.

Requirements:

- Python 3.13

1. Clone the repository:

2. Navigate to the project directory:

    cd JamAndFlow

3. Setup virtual environment:

   python -m venv venv

4. Activate the virtual environment:

   • A. for windows: ./venv/Scripts/activate
   • B. for macOS/Linux: source venv/bin/activate

5. Run FastAPI server through uvicorn:

   uvicorn app.main:app --host localhost --port 80
   or
   uvicorn app.main:app --reload

Settings up environment variables

6. Create a .env file in the root directory of the project and add the following environment variables:

   POSTGRES_USER=
   POSTGRES_PASSWORD=
   POSTGRES_DB=JamAndFlow
   POSTGRES_HOST=db
   POSTGRES_PORT=5432
   
   GENERATOR_SERVICE_URL=http://generator-service:8000

TODO: Add docker setup instructions below

1. Install Docker if you haven't already.
2. Build the Docker images:

   docker compose build --no-cache

3. Start the Docker containers:

   docker compose up

4. access the application http://localhost:8000
5. stop the containers:

   docker compose down

How to crete a new migration

1. go to root directory
2. run the following command:

   alembic -c app/alembic.ini revision --autogenerate -m "testing"

TODO: Add testing instructions below