README.md

Cooks Kingdom

Cooks Kingdom is a platform that connects busy individuals, like students, with local cooks offering
homemade food, providing convenient and delicious meal options. The website features an
easy-to-use interface, allowing customers to browse dishes, place orders, and support local
chefs, while they can manage their offerings through an admin dashboard.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About the Project
   • Project Features
   • Tools and Technologies
   • Design Diagrams
     • System Architecture Diagram
     • Database Schema Design
2. Installation Guide
   • Prerequisites
   • Installation
3. Frontend Application
4. Contributing Guide
5. Contributors
6. License
7. Acknowledgments
8. Contact

About the Project

Cooks Kingdom is a dynamic and innovative platform designed to bridge the gap between individuals seeking homemade meals and local cooks who are passionate about sharing their culinary expertise. The project's ideology revolves around providing a convenient and delicious solution for people with limited time to cook, such as students and busy professionals, while also supporting local cookers and their culinary ventures.

The primary objective of Cooks Kingdom is to create a seamless and user-friendly experience for both customers and cooks. The platform enables customers to explore a diverse range of dishes, filter options based on location and preferences, and effortlessly place orders for homemade food. On the other hand, local cooks have access to an admin dashboard, allowing them to showcase their culinary creations, post images, and provide enticing descriptions to enthrall potential customers.

At its core, Cooks Kingdom aims to foster a thriving community of food enthusiasts, where customers can indulge in delectable homemade dishes and cooks can take pride in serving their creations to a wider audience. The project stands as a testament to the power of technology in connecting people, facilitating impactful collaborations, and nurturing a sense of culinary camaraderie among diverse communities.

Cooks Kingdom empowers individuals with limited time to relish the joys of homemade meals without the hassles of cooking. It cultivates an ecosystem where local cooks can showcase their talents and build a loyal customer base. By bringing together culinary passions and technological ingenuity, Cooks Kingdom envisions transforming how homemade food is experienced and enjoyed by people worldwide. Join Cooks Kingdom in savoring the delights of homemade goodness and embracing the spirit of community-driven gastronomy.

Project Features

• CRUD Orders/Dishes/Carts
• Sign in/up/out
• Create a cutsomer or a chef account
• Edit cutsomer or a chef account
• Review a dish
• Get public dishes
• Filter publish dishes
• Sign in/up with Google
• Sign in/up with Twitter

Tools and Technologies

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

Design Diagrams

System Architecture Diagram

In this diagram, you can see the various components of our REST API, such as API routers, services, and utils, as well as our MongoDB database and how it is integrated with the rest of the project.

Database Schema Design

This is known as a UML diagram, and it shows the collections used in the database, their properties, the relationships between them, and the functionality that each collection (class) can have. We chose this diagram because it contains a lot of information and will help us organize our thoughts as we implement our application.

Installation Guide

Prerequisites

1. Node.js
2. Yarn
3. Git

Installation

1. Clone the repo

   git clone [email protected]:HishamWattar/cooks-kingdom.git

2. Navigate to the project folder

   cd cooks-kingdom

3. Install dependencies

   yarn install

4. Run the project

   yarn start

5. Run checks and tests

   yarn test

Documentation

Explore our interactive documentation API here.

Frontend Application

• Check front-end application here

• 

Contributing Guide

Contributions are what make the open source community such a wonderful place to learn, be motivated, and create. Your contributions are deeply appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

Junior Engineer	Junior Engineer	Junior Engineer	Junior Engineer	Junior Engineer
Hisham Al Wattar	Rawan Mustafa	Mahmoud Alshahin	Ahmad Alashtar	Sakarie Ali

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• 
• 
• 

Contact

Cooks Kingdom Team

Email: [email protected]