This is a comprehensive backend application for a food ordering system. It's built with TypeScript and Express.js, and uses MongoDB for data storage.
To get the project up and running, follow these steps:
- Clone the repository to your local machine.
- Install the necessary dependencies by running
npm install
. - Start the server by running
npm start
.
The project is structured as follows:
src/
- Contains the source code of the application.controllers/
- Contains the controller files for handling different routes.dto/
- Contains the data transfer objects (DTOs) used for validating incoming requests.models/
- Contains the Mongoose models for interacting with MongoDB.routes/
- Contains the route definitions for the Express application.services/
- Contains service files for business logic.utils/
- Contains utility functions and classes.
types/
- Contains TypeScript type definitions.package.json
- Contains the list of project dependencies and scripts.tsconfig.json
- Contains the TypeScript compiler configuration.
The application provides several API endpoints grouped by their functionality:
/admin
- Admin related routes./vendor
- Vendor related routes./shopping
- Shopping related routes./users
- Customer related routes./delivery
- Delivery related routes.
For more details about the specific endpoints, refer to the respective controller files in the controllers/
directory.
This project is licensed under the MIT License. See the LICENSE file for details.