How eric-jy-park/skyst-hackathon works
Project type and purpose
• This is a backend RESTful API built with NestJS (a progressive Node.js framework) in TypeScript.
• Purpose: manage bands, comments, seasons, users, videos, and votes—exposing HTTP endpoints via controllers, coordinating business logic in services, and persisting data with TypeORM entities.
File structure
• Top-level config: Dockerfile, docker-compose.yml, GitHub workflows, ESLint, tsconfig, Nest CLI.
• src/app.module.ts + src/main.ts: application root and HTTP server bootstrap.
• src/{bands, comments, seasons, users, videos, votes}: self-contained Nest modules, each with controller, service, DTOs, and entities.
• test/: end-to-end tests.
README for additional insights
• Confirms a starter NestJS project, with instructions for running, testing, and deploying.
Elements
• Clear labels: “Client (HTTP Request)”, “NestJS HTTP Server”, “BandsController”, “BandsService”, “BandRepository”, “PostgreSQL”
• Client → Controller (HTTP)
• Controller → Service (method calls)
• Service → Repository/EntityManager → Database
• Rectangles for modules
• Rounded rectangles for controllers / services
Detailed breakdown for each module
• AppModule
• Imports all feature modules
• Feature Module (e.g., BandsModule)
• Controller: handles routing & validation via DTOs
• Service: business logic, orchestrates calls to repository
• Entity: defines DB schema
• Common Layer
• BaseEntity: shared fields (show as a note, not a direct mapping to every entity)
Summary
• Inside, group by module: Controllers (edge), Services (core), Repositories (near DB).
• Database at the bottom.
• This will give a clear, detailed view of the architecture without over-mapping shared inheritance.