How cybersecurityluxembourg/openxeco-core works
Project type and purpose
• This is a full-stack, multi-component web application (“openXeco core”) comprising:
• A RESTful backend API (oxe-api) implemented in Python/Flask.
• Two single-page React frontends: oxe-web-admin (administrator UI) and oxe-web-community (public/community UI).
• Development and production deployment via Docker (docker-compose).
• Purpose: Manage cybersecurity community data (articles, entities, campaigns, forms, media, users, etc.) through admin and public interfaces, persisting data in MariaDB and sending emails via SMTP.
File-structure analysis
• Top-level:
• .docker folder & docker-compose.yml – defines shared Docker network, volumes for MariaDB & media.
• oxe-api/ – Flask app, configuration, resources (API endpoints), migrations (Alembic), Dockerfiles, tests.
• oxe-web-admin/ and oxe-web-community/ – React projects (source under src/, public assets under public/), Dockerfiles, package.json.
• doc/ and README.md – overall documentation & server install instructions.
• Patterns:
• API subfolders organized by resource type (account, article, campaign, …), each exposing CRUD operations.
• Flask uses decorators (authentication, logging, exception handling).
• Migrations via Alembic manage schema evolution.
• Frontends use React components (pages, dialogs, items, forms, charts) connecting to API via HTTP requests (utils/request.jsx).
• Deployment files: Dockerfiles for each service, GitHub Actions workflows for CI/CD.
Key README insights
• Single docker-compose up brings up: MariaDB, fake SMTP, API, admin UI, community UI.
• Env vars for DB connection, JWT_SECRET, mail server, storage paths.
• Exposed ports:
• API: 5000 (Flask)
• Admin UI: 3000 (serving React build)
• Community UI: 3001
• SMTP UI: 1080
• MariaDB: 3306
Main components
a. Presentation layer
• oxe-web-admin container (React)
• oxe-web-community container (React)
b. API layer
• oxe-api container (Flask application + WSGI)
c. Data layer
• MariaDB container (persistent volume)
• File storage volumes for images and documents (host or Docker volumes)
d. External services
• SMTP server container (fake SMTP for dev/test)
• GitHub Actions CI/CD pipelines (optional)
Component interactions and relationships
• User browsers ⇄ HTTP(S) ⇄ React frontends
• React frontends ⇄ REST calls ⇄ Flask API
• Flask API ⇄ SQL queries ⇄ MariaDB
• Flask API ⇄ file I/O ⇄ image/document volumes
• Flask API ⇄ SMTP ⇄ mail delivery
• Docker network “openxeco” connects API, DB, SMTP; frontends connect to API via network aliases or exposed ports.
Architectural patterns & principles
• Layered architecture: clear separation between UI, business logic (services/resources), and persistence.
• Modular REST resources: each resource folder in oxe-api implements one business domain.
• Configuration via environment variables (12-factor).
• Containerization: each major component runs in its own Docker container.
• CI/CD: automated builds and security checks via GitHub workflows.
• Database migrations ensure schema versioning (Alembic).