LAMFO AI API Backend

This directory contains the backend API for the LAMFO website, built with FastAPI and SQLAlchemy. It provides endpoints and database models for managing LAMFO members, projects, and related data.

Purpose

This backend serves as the core API for the LAMFO group, supporting member and project management, and is designed for easy integration with both development (SQLite) and production (PostgreSQL) databases.

Structure

• app/ — Main application code (FastAPI app, models, schemas, CRUD, database setup)
• tests/ — Unit tests using pytest and SQLite for isolation
• pyproject.toml — Project configuration and dependencies
• docker-compose.yml — For running with Docker and PostgreSQL
• alembic.ini, etc. — Configuration files

Usage

1. Install dependencies:

   pip install -e .

2. Run the API (development):

   uvicorn app.main:app --reload

3. Run tests:

   pytest

Testing

The project includes several test suites:

1. Database Tests: Test basic CRUD operations and database interactions
2. API Tests: Test the API endpoints for expected behavior
3. PostgreSQL Tests: Integration tests with the PostgreSQL database (these are skipped if PostgreSQL is not available)

To run the tests:

# Run all tests
pytest

# Run specific test files
pytest tests/test_api.py
pytest tests/test_database.py
pytest tests/test_postgres.py

# Run with verbose output
pytest -v

Docker Compose

The project includes a docker-compose.yml file for several reasons:

1. Environment consistency: Ensures the same environment across development and production
2. Service orchestration: Manages the API and database services together
3. Dependency management: Handles the dependency between the API and the database
4. Volume management: Manages persistent data storage for the database
5. Network configuration: Creates isolated networks for services
6. Easy deployment: Simplifies deployment with a single command

To use Docker Compose:

# Start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop all services
docker-compose down

Environment Setup

Before running the application, you need to set up environment variables:

1. Copy the example environment file:

   cp .env.example .env

2. Edit the .env file and fill in the actual values for your environment.

Environment Variables

The application uses the following environment variables:

General Settings

• ENVIRONMENT: Application environment (default: "production") - Options: production, development, staging
• TEST_MODE: Set to "true" for SQLite, "false" for PostgreSQL (default: "false")

Database Settings

• SQLITE_URL: SQLite database URL (default: "sqlite:///./test.db") - Used when TEST_MODE=true
• POSTGRES_USER: PostgreSQL user (default: "lamfo")
• POSTGRES_PASSWORD: PostgreSQL password (required - no default for security)
• POSTGRES_HOST: PostgreSQL host (default: "database")
• POSTGRES_PORT: PostgreSQL port (default: "5432")
• POSTGRES_DB: PostgreSQL database name (default: "lamfo_db")

Important: When TEST_MODE=false, all PostgreSQL environment variables must be properly set.

Connecting to PostgreSQL

These variables can be set in the .env file or passed as environment variables.

To check database connectivity, run:

python check_db.py

Notes

• The API docs are available at /docs when running the server.
• See app/populate_db.py for mock data generation.

---

For questions or contributions, contact the LAMFO team.