How iamjunki/my-etsidi works
Project type and purpose
• Full-stack, monolithic web application.
• Static client (HTML/CSS/JS) under client/, served by an Express server.
• RESTful API and feature modules in server/modules/
• Postgres relational database under server/database/
• Redis for session caching (see server/modules/utils/redisClient.js)
• External integrations: SMTP mail service, Google OAuth & Calendar APIs
File structure
Top-level components:
• client/ – multiple static pages (login, signup, dashboard, etc.)
• server/ – main Express app (index.js), feature modules, DB config, migrations, models
• server/modules/ – each feature (auth, calendario, gestorData, mapa, noticias, email, googleCalendar, inicio) follows a handler/router/service pattern
• server/database/ – Knex/Sequelize migrations, models, connection setup
• server/modules/utils/ – cross-cutting utilities (rate-limiter, Redis client, UPM accounts helper)
Core architectural patterns
• Layered (handler → router → service → data-access)
• Feature-based modularization (each module owns its routes, services, and helpers)
• REST API endpoints for client communication
• Middleware for auth (Passport), rate limiting, and caching
Main components
A. Client (browser)
– Static pages under client/
B. Web Server (Express Monolith)
– index.js (entry point)
– Middleware layer (auth, limiter, body-parser)
– Router layer → feature routers (auth, calendario, googleCalendar, gestorData, mapa, noticias, email, inicio)
– Service layer (business logic)
– Data-access layer (models & migrations)
C. Database
– PostgreSQL instance
– Knex/Sequelize ORM for migrations and models (usuarios, horarios, noticias, etc.)
D. Cache/Session Store
– Redis (session storage)
E. External Services
– SMTP email transporter (server/modules/email/transporter.js)
– Google OAuth & Calendar APIs (server/modules/auth/passportStrategies.js, server/modules/googleCalendar/services.js)
Relationships and interactions
1. Client → Express API (REST calls)
2. Express → Middleware
3. Middleware → Routers → Handlers → Services
4. Services →
• Database (read/write)
• Redis (session reads/writes)
• External APIs (email, Google Calendar)
5. Database and Redis respond back to Services → Handlers → Routers → Client
Important architectural/design principles
• Single codebase “monolith” but modular by feature
• Clear separation of concerns: static assets vs. dynamic API logic
• Reusable utilities in modules/utils/
• Migrations and models isolate schema definition from business logic
• Environment variables for configuration (.env)