How key-runnnnnnn/flights-and-search-service works
Project type and purpose
• This is a Node.js-based, RESTful “Flight Service” API.
• It exposes CRUD and search endpoints around flights, airplanes, airports, and cities.
• It uses Express.js for routing, Sequelize (ORM) for MySQL interactions, plus migrations/seeders for database lifecycle.
File structure
• Top-level:
• package.json / package-lock.json – Node dependencies and scripts
• src/index.js – app entry point (loads config, starts Express)
• src/config – environment & DB configuration (db.js, serverConfig.js, config.json stub)
• src/routes & src/routes/v1 – HTTP route definitions (versioned API)
• src/controllers – handle incoming requests, call services
• src/services – business logic, orchestrates calls to repositories
• src/repository – data-access layer, wraps Sequelize models
• src/models – Sequelize model definitions
• src/migrations & src/seeders – DB schema and initial data scripts
• src/middlewares – request/response processing (validation, error handling)
• src/utils – shared helpers and error codes
README for additional insights
• Describes environment setup (.env, PORT=3000, src/config/config.json)
• DB domain model:
• City 1-to-many Airport
• Airport 1-to-many Flight
• Airplane 1-to-many Flight
Be detailed but modular
• Do not collapse related but distinct modules (e.g., show separate repositories even if they share a base class)
• Essential elements: config loader, error utils, helper utilities