How agu-aariza/dockus works
Project type and purpose
• From the file tree you have:
• A .env.example and docker-compose.yml at the root
• A docs folder containing PDFs and Markdown with titles in Spanish (“Memoria Técnica…”, “Resumen Ejecutivo…”, “guia_fase_1.md”)
• A README.md (currently empty)
• These clues point to a Docker-based, full-stack platform—likely a “Reproducible Environments” platform (TFG = Trabajo Fin de Grado). It’s neither a simple library nor a compiler but a container-orchestration web application (UI + API + services + persistence).
File structure
• Top level:
• .env.example – sample environment variables
• docker-compose.yml – multi-container definitions
• docs/ – design docs, technical memory, executive summary
• Absence of dedicated “frontend” or “backend” folders in the root suggests that actual source code lives alongside or inside subfolders referenced by docker-compose.yml. The compose file is the primary architectural entry point.
• No explicit code directories or config subfolders (yet), so the containers themselves define the primary components.
README for additional insights
• README.md is empty, so you must reverse-engineer from docker-compose.yml and docs:
• Open docs/guia_fase_1.md for hints on phase 1 architecture
• Check the PDFs for high-level system descriptions
a. Main components (based on docker-compose.yml):
1. Web UI container (e.g., React, Angular, Vue)
2. API server container (e.g., Node.js, Django, Flask)
3. Database container (e.g., PostgreSQL, MySQL)
4. Optional supporting services (Redis, message queues)
5. Docker Engine / Host VM
6. External services (Git registry, object storage, CI/CD) if referenced in docs
b. Relationships and interactions:
• Users → Web UI (HTTP/HTTPS)
• Web UI ↔ API server (REST/WebSocket)
• API server → Database (TCP/SQL)
• API server → Supporting services (Redis/pub-sub)
• docker-compose.yml orchestrates start-up & network
c. Architectural patterns:
• Container-based microservices
• Environment-variable configuration (.env) injected at runtime
• Separation of concerns: UI layer / API layer / Data layer
d. Technologies:
• Docker & Docker Compose
• Language/framework of UI & API (pull from Dockerfiles or docs)
• Database engine
• Any orchestration or CI scripts (in docs)