How eyad-abdelmohsen/library_api works
Project type and purpose
• This is a NestJS‐based monolithic backend REST API.
• It manages users, authors, books, and book rating statistics, and it supports JWT authentication and file uploads (images) stored under /uploads.
File structure
• Top‐level modules in src/:
• auth – authentication (login, token issuance)
• user – user management
• author – author CRUD
• book – book CRUD
• book-stats – rating/upsert statistics
• Each module follows the NestJS pattern:
Controllers → Services → Repositories → Models
• Cross-cutting code in src/common: Multer interceptor & pipe for file uploads.
• Utility code in src/utils/jwt.ts for signing/verifying JWTs.
• Models under src/models represent database schemas/entities.
• Upload directory holds persisted images.
• E2E/integration tests under test/.
README
• Uses TypeScript, Node.js, Nest CLI, and typical commands (start, test).
a. Components to include
• HTTP Gateway (NestJS Application)
• Controllers: AuthController, UserController, AuthorController, BookController, BookStatsController
• Global/Middleware: MulterInterceptor, MulterPipe
• Business Logic Layer
• Services: AuthService, UserService, AuthorService, BookService, BookStatsService
• Persistence Layer
• Repositories: UserRepository, AuthorRepository, BookRepository, BookStatsRepository
• Database (e.g., PostgreSQL/MySQL)
• Utilities
• JWT Utility (sign/verify tokens)
• File Storage
• Local FS (/uploads) or external blob storage
b. Relationships & data flow
1. Client ▶ HTTP request ▶ appropriate Controller
2. Controller ▶ Service (business logic)
3. Service ▶ Repository (data access) ▶ Database
4. Database ▶ Repository ▶ Service ▶ Controller ▶ HTTP response ▶ Client
5. Auth paths use JWT util to sign/validate tokens
6. File upload endpoints go through MulterInterceptor ▶ MulterPipe ▶ local storage
c. Architectural patterns & design principles
• Modular structure: each domain area is its own NestJS module.
• Layered architecture: Controller → Service → Repository → Model.
• Dependency Injection: controllers inject services; services inject repositories/utilities.
• DTOs for input validation (in src/*/dto).
• Cross‐cutting concerns (interceptors, pipes).
d. Key technologies
• NestJS (Modules, Controllers, Services, Interceptors, Pipes)
• TypeScript
• JWT for auth
• Multer for file uploads
• ORM/Query builder (inferred from repositories—could be TypeORM, Prisma, etc.)