How real-dev-squad/website-backend works
Main System Components
a) API Layer
• Entry point (app.js, server.js)
• Routes layer (/routes)
• Controllers layer (/controllers)
• Middleware layer (/middlewares)
b) Core Services
• Authentication services (OAuth with GitHub)
• Business logic services (/services)
• Data access layer
c) External Integrations
• GitHub OAuth
• Firebase/Firestore
• Discord integration
• CloudFlare
• AWS services
• Cloudinary
d) Data Storage
• Firestore database
• Cache layer
Component Relationships
a) Request Flow:
Client Request → Routes → Middlewares (Authentication/Authorization) → Controllers → Services → Data Access Layer → Database
b) Authentication Flow:
Client → GitHub OAuth → Auth Service → Token Generation → User Storage
Specific Architectural Elements
a) Middleware Chain
• Authentication (middlewares/authenticate.js)
• Authorization (middlewares/authorization.js)
• Rate Limiting (middlewares/rateLimiting.js)
• Validators (middlewares/validators/*)
b) Service Layer Organization
• Auth Services
• Discord Services
• GitHub Services
• Image Services
• Trading Services
• User Services
Important Design Patterns to Highlight
• MVC-like pattern (routes → controllers → models)
• Service layer pattern
• Middleware chain pattern
• Repository pattern (data access layer)
Specific Implementation Details
Specialized features:
• Task management system
• User status tracking
• Extension request handling
• Event management
• Wallet and trading systems
Cross-Cutting Concerns
Aspects:
• Logging system (utils/logger.ts)
• Error handling
• Caching mechanisms
• Rate limiting
• Monitoring (monitor.js)
┌─ Client Layer ─────────────────────────────┐
• API Gateway Layer ────────────────────────┤
• (Routes, Rate Limiting, Response Headers) │
• Security Layer ─────────────────────────┤
• (Auth, Authorization, Validation) │
• Business Logic Layer ───────────────────┤
• (Controllers, Services) │
• Data Access Layer ────────────────────────┤
• (Models, Data Access Layer) │
• External Services Layer ─────────────────┤
• (GitHub, Discord, CloudFlare, etc.) │
• ┘
Remember to:
• Async operations
• Security boundaries
• Scalability points
• Monitoring and logging points