How bibbox/sys-bibbox works
Project Type and Purpose
• This is a containerized, full-stack, modular web application (“BIBBOX Framework”) for deploying and managing bioinformatics apps.
• It comprises an Angular single-page frontend, a Flask-based Python backend, background task workers, several infrastructure services (DB, cache/message broker, auth, monitoring), and an HTTP/TCP proxy layer.
File Structure Analysis
• Top-level folders:
• frontend/ – Angular client code, build scripts, Dockerfile
• backend/ – Flask app (WSGI entrypoints, API modules, Celery tasks, services, models), Dockerfile, uWSGI, Celery config
• apacheproxy/, nginx/, postgresql/, keycloak/, redis (implied in compose) – per-service Dockerfiles and configs
• config-templates/, proxy-configs/, fdp-configs/ – templated configuration for deployment
• docker-compose*.yml – development and production service orchestration
• CI/CD workflows under .github/workflows for Node.js, Docker image build & publish, deployment.
• README describes a multi-container Docker environment with key components: apacheproxy, backend (Flask), celery, postgres, redis, keycloak, adminer, cadvisor.
Key Architecture Insights from README
• Each major service runs in its own Docker container, orchestrated via Docker Compose on a shared network.
• The Angular frontend is served by apacheproxy (HTTPD) which also proxies API calls to Flask.
• Flask backend exposes REST endpoints, connects to Postgres (activity, logs, users), and to Redis (celery broker).
• Celery workers pick up background jobs from Redis.
• Keycloak provides OAuth2/OpenID authentication; Angular and Flask both integrate with it.
• Adminer and cadvisor run as auxiliary containers for DB management and container monitoring.
Depth & Detail
• Essential containers as separate nodes.
• Internal subcomponents only where critical (e.g., Celery beat vs. worker).
• Environment-specific overrides if useful (dev vs. prod compose).
• Don’t overcomplicate – group closely related files/services under the same block.