https://github.com/basith-p/food-order
https://github.com/basith-p/food-order
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/basith-p/food-order
- Owner: Basith-P
- License: mit
- Created: 2024-05-27T11:25:34.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T09:47:12.000Z (about 2 years ago)
- Last Synced: 2025-02-01T04:44:19.722Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 406 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](#getting-started)
- [Project Structure](#project-structure)
- [API Endpoints](#api-endpoints)
## 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.