How briangor/movie-recommendation-server works
Project Type and Purpose
• This is a backend-only, full-stack application’s API layer (no frontend code in this repo).
• Purpose: expose a RESTful Movie Recommendation Server built on Node.js, Express and MySQL, handling movies and genres.
File Structure & Architectural Patterns
• src/index.ts: boots the Express server, loads middleware and routes.
• src/config/db.config.ts: holds DB connection parameters.
• src/database.js: sets up the actual connection (e.g., Sequelize or mysql2).
• src/routes/*.ts: Express routers defining HTTP endpoints by resource (movie, genre).
• src/controllers/*.ts: business logic—take request params, invoke model methods, send responses.
• src/models/*.ts: define ORM models (db.model.ts for init, movie.model.ts, genre.model.ts).
• src/utils/helper.ts: shared utility functions.
• This follows a classic layered (Router → Controller → Model → Database) architecture.
Key Components
a. External Clients
• API consumer (web app, mobile app, automated scripts).
b. Express Application
• index.ts (entry point)
• Configuration layer (db.config.ts)
• Routing layer (movie.routes.ts, genre.routes.ts)
• Controller layer (movie.controller.ts, genre.controller.ts)
• Model/ORM layer (db.model.ts sets up ORM, movie.model.ts, genre.model.ts)
• Utilities (helper.ts)
c. Database
• MySQL server (with movies and genres tables)
Relationships & Data Flow
1. Client → HTTP Request → Express server (index.ts).
2. Express → Routing layer (router matches /movies, /genres).
3. Router → Controller (e.g., movie.controller.findAll()).
4. Controller → Model methods (e.g., Movie.findAll(), Genre.create()).
5. Model → MySQL (via Sequelize/mysql2).
6. MySQL response → Model → Controller → Express → Client.
7. Config (db.config.ts) injected into DB layer; utilities available anywhere.
Architectural Patterns & Design Principles
• Layered architecture (Presentation/Routes, Business/Controllers, Data/Models).
• Single Responsibility per module.
• Configuration separated from code.
• Utility functions extracted to avoid duplication.
Technologies & Frameworks
• Node.js + Express (web framework)
• TypeScript (static typing)
• MySQL (relational database)
• ORM (likely Sequelize or mysql2)
• nodemon for live reloading (nodemon.json)