jfxs/aerodebrief-api repository overview

⁠AeroDebrief Backend

Django backend for the AeroDebrief flight analysis platform.

The Docker Hub registry.

The Quay.io registry.

Docker tags: 1.5.2-001, 1.5, 1, latest

⁠Overview

API backend for the AeroDebrief application. Handles flight data management and analysis. Uses Django Ninja for REST APIs and PostgreSQL for storage.

⁠Features

• Fleet Management — Aircraft tracking (registration, type, MTOW).
• User Management — Authentication via Django allauth⁠.
• API — RESTful endpoints with Django Ninja⁠.
• Docker — Containerized dev and deployment environments.
• Code Quality — mypy/pyrefly (strict typing), ruff (lint/format), pre-commit hooks.
• Testing — Unit tests and functional tests with pytest⁠ and factory_boy.
• Task Automation — Common tasks managed with Taskfile⁠.

⁠Quick Start

⁠Prerequisites

• uv⁠ (Python package management)
• Docker⁠ & Docker Compose
• Task⁠ (optional, but handy)

⁠Installation

1. Clone the repository:

   git clone https://gitlab.com/op_so/projects/aerodebrief-backend.git
   cd aerodebrief-backend
   

   Copy

2. Install dependencies:

   uv sync
   

   Copy

3. Set up the environment: Copy the example environment file and adjust as needed.

   cp env.example .env
   

   Copy

4. Create local data directories and start infrastructure:

   task 00:020-create-data-dir
   rm -rf ./.data/postgresql
   mkdir -p ./.data/postgresql && chmod 777 ./.data/postgresql
   docker compose up
   task 00:030-reset-db
   uv run manage.py runserver
   

   Copy

   API: http://127.0.0.1:8000/api/v1
   Doc: http://127.0.0.1:8000/api/v1/docs
   Admin: http://127.0.0.1:8000/admin
   Mailpit: http://127.0.0.1:8025/
   PgAdmin: http://127.0.0.1:8888/

⁠Development

Common tasks are available via Taskfile:

⁠Code Quality & Testing

⁠Database Management

⁠Docker Local Dev

Run the full local stack after building images:

docker compose -f compose.local.dev.yml up

⁠Software Bill of Materials

⁠Authors

• FX Soubirou - Initial work - GitLab Repositories⁠

⁠License

This project is licensed under the GNU Affero General Public License (AGPL) - see the LICENSE⁠ file for details.