Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.76 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.76 KB

Food-Order Application

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.

Table of Contents

Getting Started

To get the project up and running, follow these steps:

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies by running npm install.
  3. Start the server by running npm start.

Project Structure

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.

API Endpoints

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.

License

This project is licensed under the MIT License. See the LICENSE file for details.