README.md

Comidit.App · Back-End

Final project linked to Fullstack's Development course organized by Industrial Business School

From September 2021 to December 2021

View Demo · Report a Bug · Front-End Repository »

Index

Table of Contents

1. About Comidit.App
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

(back to top)

About Comidit.App

Comidit.App makes your orders easy and fast, accompanying you in your everyday life.

We know there's a lot of websites where you could order your food but... Are you sure they are THIS AMAZING? 💛

Our goal is to provide a free, easy, and responsive web application for restaurants who want to make the process of managing their orders easier, in addition to staying closer to their customers while offering the best delivery service. Comidit.App is designed for people, providing an intuitive, effortless offering of the most valuable restaurants of your area.

Comidit.App is our final project for the Fullstack's Development course organized by the Industrial Business School in Spain. This project was developed from September to December 2021 with non commercial purposes.

Built With

(back to top)

Getting Started

Installation

1. Clone the repository

https://github.com/fullstacktf/order-food-backend.git

(back to top)

Usage

To get the server up and running, just run:

make

(back to top)

Roadmap

We're still working on Comidit.App. Meanwhile, you can check our progress (kanban board).

According to our MVP we will develop this features. The unchecked ones are extra features we would like to work on after.

• Restaurants
  • Manage Menu and Products
  • Manage Orders
  • Manage Own Info
  • Offer tracking delivery (map)
• Clients
  • Order Food
  • Check Status
  • Manage Own Info
  • Delete Account
  • Mark & Check your favourite restaurants
  • Give reviews (stars)

(back to top)

License

Distributed under Creative Commons BY-NC-SA. This license allows reusers to distribute, remix, adapt, and build upon the material in any medium or format for noncommercial purposes only, and only so long as attribution is given to the creator. If you remix, adapt, or build upon the material, you must license the modified material under identical terms. CC BY-NC-SA includes the following elements:

• BY - Credit must be given to the creator

• NC - Only noncommercial uses of the work are permitted

• SA - Adaptations must be shared under the same terms

Aside from that we use MIT License.

(back to top)

Contact

About our team:

• Nicolás Cabrera Domínguez- GitHub · Profile

• Néstor Torres Diaz - GitHub · Profile

(back to top)

Acknowledgements

• Prototype made with Figma: Desktop MockUp - Mobile MockUp
• Logotype & Branding: Adobe Illustrator, Adobe Color
• Images: Unsplash, Freepik, Emojipedia

(back to top)