How thiago-laurence/proyecto-de-software works
Project type and purpose
• This is a two‐part full-stack web application:
– “admin” is a Flask-based administrative backend (Python, Flask, Jinja2 templates, SQLAlchemy models).
– “portal” is a Vue.js Single Page Application (SPA) front-end built with Vite, Tailwind CSS and served behind Nginx.
• The system provides:
– A secure administration interface (user/role/institution management, service orders).
– A public portal for customers to view services, place orders, and authenticate.
File structure
Top-level
• docker-compose.yml, .env – orchestrate services and environment variables.
• admin/ – Flask monolith:
• Dockerfile, entrypoint.sh – container build and startup.
• app.py, token.py, mail.py, oauth.py – application entry points.
• src/core/models – SQLAlchemy models (User, Role, Institution, ServiceOrder, etc.).
• src/web/controllers – Blueprints organized by API, authentication, pages.
• templates & static – Jinja2 HTML templates, CSS/JS assets, Tailwind config.
• tests – unit tests.
• portal/ – Vue 3 SPA:
• Dockerfile, nginx/default.conf – containerized front end served by Nginx.
• src/ – main.js, router, stores (Pinia), components, views.
• api.js – HTTP client for communicating with the Flask API.
• tailwind.config.js, vite.config.js – build and styling config.
README for additional insights
• Describes roles (root, owner, admin, operator, user) and credentials for demo.
• Technology stack: Git/GitLab, Python, Flask, JavaScript, Vue.js, HTML5/CSS3.
Diagramming the architecture
a. Main components
– SPA Front-end (Vue.js app)
– Admin Web App (Flask monolith)
– Relational Database (e.g., PostgreSQL)
– Reverse Proxy / Web Server (Nginx for portal)
– Docker & Docker Compose (orchestration)
– External services (SMTP mail service, optional OAuth provider)
b. Relationships and interactions
– User’s browser ↔️ Nginx (serves SPA)
– SPA ↔️ Flask API (via JSON over HTTP, api.js uses axios/fetch)
– Browser ↔️ Flask server (for admin UI templated pages)
– Flask ↔️ Database (ORM queries to SQL database)
– Flask ↔️ Mail server (via mail.py)
– Docker Compose ↔️ orchestrates containers (admin, portal, database, redis if used)
c. Architectural patterns and principles
– MVC / Blueprint pattern in Flask (models, controllers, templates)
– Single Page Application on front end with client-side routing (Vue Router)
– Separation of concerns:
• Front-end static assets vs back-end API logic.
• Configuration and code in containers.
– 12-factor app principles (env vars, config files, stateless containers)
d. Key technologies & libraries
– Python, Flask, Jinja2, SQLAlchemy, bcrypt, Alembic/seeds
– JavaScript, Vue.js, Pinia (stores), Vue Router, Vite, Tailwind CSS
– Docker, docker-compose, Nginx, Git/GitLab CI
Final recommendations
• Drill down: inside the Flask container, show MVC structure and dependencies.