food-order-delivery

◦ Developed with the software and tools below.

---

📖 Table of Contents

• 📖 Table of Contents
• 📦 Features
• 📂 Repository Structure
• ⚙️ Modules
• 🚀 Getting Started
  • 🔧 Installation
  • 🤖 Running food-order-delivery
  • 🧪 Tests
• 🛣 Roadmap
• 🤝 Contributing
• 📄 License
• 👏 Acknowledgments

---

📂 Repository Structure

└── food-order-delivery/
    ├── .deepsource.toml
    ├── .gitignore
    ├── README.md
    ├── package-lock.json
    ├── package.json
    ├── prettier.config.js
    ├── src/
    │   ├── config/
    │   │   └── index.ts
    │   ├── controllers/
    │   │   ├── adminController.ts
    │   │   ├── customerController.ts
    │   │   ├── deliveryController.ts
    │   │   ├── index.ts
    │   │   ├── shoppingController.ts
    │   │   └── vendorController.ts
    │   ├── dto/
    │   │   ├── auth.dto.ts
    │   │   ├── customer.dto.ts
    │   │   ├── food.dto.ts
    │   │   ├── index.ts
    │   │   └── vendor.dto.ts
    │   ├── index.ts
    │   ├── middlewares/
    │   │   ├── commonAuth.ts
    │   │   └── index.ts
    │   ├── models/
    │   │   ├── Customer.ts
    │   │   ├── DeliveryUser.ts
    │   │   ├── Food.ts
    │   │   ├── Offer.ts
    │   │   ├── Order.ts
    │   │   ├── Transaction.ts
    │   │   ├── Vendor.ts
    │   │   └── index.ts
    │   ├── routes/
    │   │   ├── adminRoute.ts
    │   │   ├── customerRoute.ts
    │   │   ├── deliveryRoute.ts
    │   │   ├── index.ts
    │   │   ├── shoppingRoute.ts
    │   │   └── vendorRoute.ts
    │   ├── services/
    │   │   ├── database.ts
    │   │   └── expressApp.ts
    │   └── utility/
    │       ├── index.ts
    │       ├── notificationUtility.ts
    │       └── passwordUtility.ts
    ├── tsconfig.json
    └── yarn-error.log

---

⚙️ Modules

Root

File	Summary
yarn-error.log	HTTPStatus Exception: 429
prettier.config.js	HTTPStatus Exception: 429
.deepsource.toml	HTTPStatus Exception: 429

Src

File	Summary
index.ts	HTTPStatus Exception: 429

Models

File	Summary
Offer.ts	HTTPStatus Exception: 429
Transaction.ts	HTTPStatus Exception: 429
Food.ts	HTTPStatus Exception: 429
Vendor.ts	HTTPStatus Exception: 429
index.ts	HTTPStatus Exception: 429
Order.ts	HTTPStatus Exception: 429
DeliveryUser.ts	HTTPStatus Exception: 429
Customer.ts	HTTPStatus Exception: 429

Config

File	Summary
index.ts	HTTPStatus Exception: 429

Services

File	Summary
expressApp.ts	HTTPStatus Exception: 429
database.ts	HTTPStatus Exception: 429

Middlewares

File	Summary
commonAuth.ts	HTTPStatus Exception: 429
index.ts	HTTPStatus Exception: 429

Controllers

File	Summary
deliveryController.ts	HTTPStatus Exception: 429
shoppingController.ts	HTTPStatus Exception: 429
index.ts	HTTPStatus Exception: 429
vendorController.ts	HTTPStatus Exception: 429
customerController.ts	HTTPStatus Exception: 429
adminController.ts	HTTPStatus Exception: 429

Dto

File	Summary
vendor.dto.ts	HTTPStatus Exception: 429
index.ts	HTTPStatus Exception: 429
customer.dto.ts	HTTPStatus Exception: 429
food.dto.ts	HTTPStatus Exception: 429
auth.dto.ts	HTTPStatus Exception: 429

Routes

File	Summary
vendorRoute.ts	HTTPStatus Exception: 429
customerRoute.ts	HTTPStatus Exception: 429
adminRoute.ts	HTTPStatus Exception: 429
shoppingRoute.ts	HTTPStatus Exception: 429
index.ts	HTTPStatus Exception: 429
deliveryRoute.ts	HTTPStatus Exception: 429

Utility

File	Summary
notificationUtility.ts	HTTPStatus Exception: 429
passwordUtility.ts	HTTPStatus Exception: 429
index.ts	HTTPStatus Exception: 429

---

🚀 Getting Started

🔧 Installation

1. Clone the food-order-delivery repository:

git clone https://github.com/eraykeskinmac/food-order-delivery

2. Change to the project directory:

cd food-order-delivery

3. Install the dependencies:

npm install

🤖 Running food-order-delivery

npm run build && node dist/main.js

🧪 Tests

npm test

---

🤝 Contributing

Contributions are always welcome! Please follow these steps:

1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

4. Make changes to the project's codebase.
5. Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'Implemented new feature.'

6. Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

7. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

---