How anbinh93/project-it4082 works
Project type and purpose
• This is a RESTful backend API service built with Node.js, Express and Sequelize.
• Its domain is population and household management plus fee/payment tracking (entities: users, residents (nhankhau), households (hokhau), temporary stay/absence, fees (khoanthu), payment records (nopphi), statistics).
File structure
• Top-level “03_Developement/server” holds the entire runtime service.
• config/: database connection settings
• controllers/: business-logic handlers per resource
• routes/: Express route definitions mapping URLs → controllers
• middlewares/: e.g. auth token validation
• db/migrations & db/seeders: versioned database schema evolution & initial data
• db/models: Sequelize models, ORM layer
• docs/: API specifications & Postman guides
• scripts/: ad-hoc CLI utilities (createAdmin, updateUserRole)
• server.js: entry point, Express app initialization
• package.json: lists dependencies (Express, Sequelize, authentication libs)
• No frontend code is present—this is purely a backend microservice.
README
• Confirms this is a class-project API server.
Detail
• Layer/component from the file tree (config, routes, controllers, models, migrations).
• Don’t omit the middleware or scripts—they are part of the operational architecture.
• The goal is a “bird’s-eye” view that still pinpoints every major piece of code in the repo.