How breymene/rubricas-itm works
Project Type and Purpose
• This is a full-stack web application (“RubrITM”) for ITM university, built to let professors create, manage, and share evaluation rubrics.
• Frontend: Vue.js with Nuxt.js (SSR/SPA hybrid)
• Backend: Node.js with Express
• Database: MongoDB
• Deployment: Docker Compose with Nginx as a reverse proxy
File Structure
• Top-level:
• Backend/ – Express server (index.js, routes/, utils/)
• Web/ – Nuxt application (pages/, components/, layouts/, middleware/, server/)
• docker-compose.yml + nginx.conf – container orchestration & reverse proxy
• Backend:
• routes/auth.js, course.js, groups.js – API controllers
• utils/types.js, validations.js – shared validation and custom types
• Web:
• pages/ – Nuxt routes for Curso, Login, rubricas, etc.
• components/ – Vue components for Create, Register, Rubrica UI, Utilities
• middleware/auth.global.ts – global auth guard
• server/ – Nuxt server middleware (TS)
• nuxt.config.ts, tailwind.config.js – framework configuration
Extract README Insights
• API_URL set to http://localhost:8000
• MongoDB URI points at “db” service in Docker network
• Professors and students roles, email notifications sent via Outlook
Main Components & Relationships
a. Components:
• Client Browser (User interface)
• Nginx Reverse Proxy
• Frontend (Nuxt.js SSR/SPA)
• Backend API (Express.js)
• MongoDB Database
• External Email Service (Outlook SMTP)
b. Data Flows:
1. User → Browser loads URL → Nginx
2. Nginx → serves static assets / proxies to Nuxt server
3. Nuxt → SSR or API fetch → calls Backend at /auth, /groups, /course
4. Backend → performs business logic → reads/writes MongoDB
5. Backend → sends grading emails via Outlook SMTP
c. Architectural Patterns:
• MVC-style within backend (routes = controllers, utils = services)
• Component-based UI (Vue/Nuxt)
• Docker-based micro-services (each service in its own container)
• API gateway pattern via Nginx
d. Key Technologies:
• Nuxt.js / Vue.js (Frontend framework)
• Express.js (Backend framework)
• MongoDB (NoSQL database)
• Docker Compose & Nginx (Deployment and reverse proxy)
• TailwindCSS (Styling)