Installation Guide

Installation

Prerequisites

• Docker & Docker Compose: For running the app and tests.
• Python 3.11+: For local development outside Docker.
• RabbitMQ: Message broker for Celery tasks.
• PostgreSQL: Production database (SQLite for testing).

Steps

1. Clone the Repository:

   git clone https://github.com/MoigeMatino/pulse-check.git
   cd pulse-check

2. Set Up Environment: Create a .env file:

   DATABASE_URL=postgresql://user:password@localhost:5432/db_name
   RABBITMQ_URL=amqp://guest:guest@localhost:5672//
   

3. Run with Docker Compose:

   docker-compose up --build

4. Initialize Database: Apply migrations:

   docker-compose exec app alembic upgrade head

5. Verify: Check the API:

   curl http://localhost:8000/docs

Local Development (Optional)

1. Install dependencies:

   pip install -r requirements.txt

2. Run RabbitMQ separately (e.g., via Docker):

   docker run -d -p 5672:5672 rabbitmq:3

3. Initialize DB with Alembic (not SQLModel.create_all):

   alembic upgrade head

4. Start the app:

   uvicorn app:app --reload