How evcat6/balancy-app-backend works
Project type and purpose
• This is a full-stack application’s backend, implemented with the NestJS framework.
• It exposes REST endpoints for user management, authentication, tasks, and sub-categories, relies on a relational database (via TypeORM entities), and integrates external services (Google OAuth, email).
File structure
• Top-level src/app.module.ts registers all modules: Auth, Users, Tasks, SubCategories, Common, Config.
• Each module follows Nest’s pattern: <module>.controller.ts (HTTP entry point), <module>.service.ts (business logic), plus DTOs and Entity definitions under /dto and /entities.
• Common folder holds cross-cutting concerns: decorators, guards (roles, JWT), and utility services (email, logger).
• Config module loads environment variables (config-validation-schema, configuration.ts).
• Authentication uses Passport with Local, JWT, and Google strategies.
README for additional insights
• The app runs in dev/prod modes, supports unit & e2e testing.
Main components and their interactions
a. Clients
– Web or mobile clients (e.g., React/Vue, Postman) issue HTTP requests.
b. API Gateway (NestJS host)
– main.ts bootstraps the Nest application, applies global pipes (validation), exception filters if any.
1. Auth Module
• Controllers: auth.controller.ts – login, change-password, OAuth callbacks.
• Guards & Strategies: LocalAuthGuard, JwtAuthGuard, GoogleStrategy, JwtStrategy.
• Service: issues JWTs, interfaces with Users service.
2. Users Module
• Controllers: users.controller.ts – CRUD on users.
• Service: user management, password hashing.
• Entities/DTOs: mapping to DB.
3. Tasks Module
• Controllers & Service for task CRUD.
• Entities: task.entity.ts.
• Types: response interfaces.
4. SubCategories Module
• Similar to Tasks: controllers, service, entity.
5. Common Module
• Cross-cutting: logger, email service, role-based guards, custom decorators (@Public, @Roles, @User).
6. Config Module
• Loads and validates environment variables (database credentials, JWT secret, OAuth client IDs).
d. Database
– A relational DB (PostgreSQL/MySQL) accessed via TypeORM (entity classes under each module).
e. External Services
– Google OAuth endpoint
– Email provider (SMTP or transactional service)
Architectural patterns and design principles
• Layered architecture: Presentation (controllers), Business (services), Data (entities/repositories).
• Modular decomposition: each feature in its own module with clear boundaries.
• Dependency injection: all services injected via Nest’s DI container.
• Cross-cutting concerns handled by Common module (guards, decorators).
• Configuration isolation via Config module.
Detail
• Call out global pipes/guards on the API boundary.
• Config module feeding secrets/config into modules.