How okfde/froide works
Project type and purpose
• Froide is a full-stack, internationalized Freedom-of-Information web portal built on Django (Python) with a Vue/TypeScript frontend.
• It provides public request filing, document storage/viewing, search (Elasticsearch), background processing (Celery), email notifications (SMTP), and geospatial features (PostGIS/GDAL).
High-level file structure and clues to architecture
• Top-level “froide/” directory: the Django monolithic codebase, split into many apps (account, document, foirequest, publicbody, etc.).
• “frontend/” directory: Vue single-page-app components, API clients (generated from OpenAPI), static assets, styles, and build config (Vite, pnpm).
• Docker compose (“compose-dev.yaml”) spins up Postgres+PostGIS and Elasticsearch.
• Celery config (“froide/celery.py”) indicates a task queue for asynchronous jobs.
• Configuration files: manage.py, settings.py, local_settings.py.example, openapi-schema.yaml, tsconfig.json, vite.config.ts.
Key points from README
• Dependencies: Python 3.12+, Node.js 22+, Docker, Postgres/PostGIS, Elasticsearch, Poppler, GDAL.
• Run services via Docker Compose on ports 5432 (DB) and 9200 (search).
• Django migrations, search index creation, and a development server.
• Frontend built with pnpm and Vite or served with dev server.
Detail without over-splitting
• Domain app only if it has its own service boundary; otherwise group under “Django monolith.”
• Infrastructure components (Docker, CI) at a high level.