Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnmata0427/food-ordering-api-restful
RESTful API for System Food Ordering at ESFOT faculty of EPN
https://github.com/johnmata0427/food-ordering-api-restful
backend expressjs mongoose restful-api
Last synced: about 20 hours ago
JSON representation
RESTful API for System Food Ordering at ESFOT faculty of EPN
- Host: GitHub
- URL: https://github.com/johnmata0427/food-ordering-api-restful
- Owner: JohnMata0427
- Created: 2024-06-27T17:55:16.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-18T02:11:34.000Z (3 months ago)
- Last Synced: 2024-10-20T18:34:42.675Z (26 days ago)
- Topics: backend, expressjs, mongoose, restful-api
- Language: JavaScript
- Homepage: https://food-ordering-api-restful.onrender.com/
- Size: 285 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
$\color{Apricot}{Food\ Ordering\ at\ ESFOT\ API\ RESTful}$
---
> [!IMPORTANT]
> **Problematic Introduction**
>
> The lunchtime rush at ESFOT poses a significant operational challenge.
> The influx of students seeking to order their meals within a limited timeframe (11 AM to 2 PM) results in the formation of long queues.
> These extended wait times not only inconvenience students but also negatively impact their overall dining experience.
> Additionally, the manual ordering process, with its inherent limitations, can lead to inefficiencies and potential errors.
> The existing system struggles to accommodate the high volume of orders during peak hours, leading to delays and frustration among students.
---
🥣 Sprint 0 - Development Environment Configuration
✅ Definition of Requirements and Constraints
> - **User Registration and Authentication**
>
> - Users must be able to register with a username, password, and other relevant details.
> - Users must be able to log in and log out of the system.
>
> - **Menu Management**
>
> - Administrators must be able to add, edit, and delete menu items.
> - Users must be able to view the available menu, including descriptions, prices, and availability of dishes.
>
> - **Placing Orders**
>
> - Users must be able to select menu items and place an order.
> - Users must be able to view a summary of their order before confirming it.
> - Users must be able to modify or cancel an order before final confirmation.
>
> - **Order History**
>
> - Users must be able to view their past orders.
> - Users must be able to repeat previous orders easily.
✅ Backend Project Structure
> - **Tools**
>
> | Image | Name |
> |--------------------------------------------------------------|----------------------------|
> |  | Visual Studio Code |
> |  | MongoDB Atlas y Compass |
> |  | Node.js |
> |  | PNPM (Recommendation) |
>
> - **Project Initialization and Installation Dependencies**
>
> - Open the terminal and run the following command:
> ```
> npm init -y
> ```
> - Now proceed to install the following modules for the development and production environment:
> ```
> npm i express bcryptjs mongoose dotenv nodemailer jsonwebtoken cors
> ```
>
> - **Project File Structure**
>
> - Now we proceed to create a series of files and directories for the web server, running each of these commands in order:
> ```
> mkdir src
> ```
> ```
> cd src
> ```
> ```
> "config","controllers",”helpers”,”middlewares”,”models”,”routers” | %{New-Item -Name “$_” -ItemType “Directory”}
> ```
> ```
> cd ..
> ```
> - Create the directories database.js index.js server.js .env .env.example .gitignore, the final result is this:
>
> 
✅ Database Development
> - MongoDB Collections
> - Chefs
> - Students
> - Orders
> - Products
✅ User Roles
> - Students 🧑🎓👩🎓
> - Chefs 👨🍳👩🍳
---
👨🍳 Sprint 1 - Chef Module
✅ Endpoints to be Developeds
>
> Development in Express
> 
>
>
> To create the backend endpoints, the MVC model is used, and the files that contain the sprint presentable are:
>
> [](/src/models/chef.js)
> [](/src/controllers/chef_controller.js)
> [](/src/routes/chef.routes.js)
>
> 🛠️ Endpoint for registration
>
> ```http
> POST /api/register
> ```
>
> 🛠️ Endpoints for sending and verifying email
>
> ```http
> GET /api/confirmar/:token
> ```
>
> 🛠️ Endpoint for login
>
> ```http
> POST /api/login
> ```
>
> 🛠️ Endpoint for password reset
>
> ```http
> POST /api/chef/recuperarpassword
> ```
>
> 🛠️ Endpoint for cheking token for password reset
>
> ```http
> GET /api/chef/recuperarpassword/:token
> ```
>
> 🛠️ Endpoint for new password
>
> ```http
> POST /api/chef/nuevopassword/:token
> ```
>
> 🛠️ Endpoint for updating profile
>
> ```http
> PUT /api/chef/:id
> ```
>
> 🛠️ Endpoint for updating password
>
> ```http
> POST /api/chef/actualizarpassword
> ```
>
> 🛠️ Endpoint for getting chef by id
>
> ```http
> GET /api/chef/:id
> ```
>
> 🛠️ Endpoint for getting all chefts
> ```http
> GET /api/chefs
> ```
▶️ Interface Design
>
> Prototyping in Figma
> 
>
>
> 🎨 Figma layout URL: https://www.figma.com/design/QgTkoUAXTEj120bpNTTu5c/Food-Ordering-Application-at-ESFOT
---
👩🎓 Sprint 2 - Student Module
✅ Endpoints to be Developeds
>
> Development in Express
>
>
>
> To create the backend endpoints, the MVC model is used, and the files that contain the sprint presentable are:
>
> [](/src/models/estudiante.js)
> [](/src/controllers/estudiante_controller.js)
> [](/src/routes/estudiante.routes.js)
>
> 🛠️ Endpoint for registration
>
> ```http
> POST /api/estudiantes/registro
> ```
>
> 🛠️ Endpoints for sending and verifying email
>
> ```http
> GET /api/estudiantes/confirmar/:id
> ```
>
> 🛠️ Endpoint for login
>
> ```http
> POST /api/estudiantes/login
> ```
>
> 🛠️ Endpoint for password reset
>
> ```http
> PUT /api/estudiantes/recuperarpassword
> ```
>
> 🛠️ Endpoint for cheking token for password reset
>
> ```http
> GET /api/estudiantes/recuperarpassword/:token
> ```
>
> 🛠️ Endpoint for new password
>
> ```http
> POST /api/estudiantes/nuevopassword/:token
> ```
>
> 🛠️ Endpoint for updating profile
>
> ```http
> PUT /api/estudiantes/:id
> ```
>
> 🛠️ Endpoint for updating password
>
> ```http
> PUT /api/estudiantes/actualizarpassword
> ```
>
> 🛠️ Endpoint for getting student by ID
>
> ```http
> GET /api/estudiante/:id
> ```
>
> 🛠️ Endpoint for getting all students
>
> ```http
> GET /api/estudiantes
> ```
>
> 🛠️ Endpoint for getting student profile
>
> ```http
> GET /api/estudiantes/perfil
> ```
>
> 🛠️ Endpoint for deleting student account
> ```http
> DELETE /api/estudiantes/:id
> ```
---
🏷️🍛 Sprint 3 - Products and Orders Module
✅ Endpoints to be Developeds
>
> Development in Express
>
>
>
> To create the backend endpoints, the MVC model is used, and the files that contain the sprint presentable are:
>
> [](/src/models/pedido.js)
> [](/src/controllers/pedido_controller.js)
> [](/src/routes/pedido.routes.js)
>
> [](/src/models/producto.js)
> [](/src/controllers/producto_controller.js)
> [](/src/routes/producto.routes.js)
>
> 🛠️ Endpoint for order registration
>
> ```http
> POST /api/pedido/registro
> ```
>
> 🛠️ Endpoints for getting order by id
>
> ```http
> GET /api/pedido/:id
> ```
>
> 🛠️ Endpoint for getting all orders
>
> ```http
> GET /api/pedidos
> ```
>
> 🛠️ Endpoint for getting all orders of authenticated student
>
> ```http
> GET /api/pedidos/estudiante
> ```
>
> 🛠️ Endpoint for updating order state
>
> ```http
> PUT /api/pedido/:id
> ```
>
> 🛠️ Endpoint for deleting order
>
> ```http
> DELETE /api/pedido/:id
> ```
>
> 🛠️ Endpoint for creating product
>
> ```http
> POST /api/productos/registro
> ```
>
> 🛠️ Endpoint for getting all products
>
> ```http
> GET /api/productos
> ```
>
> 🛠️ Endpoint for getting product by id
>
> ```http
> GET /api/productos/:id
> ```
>
> 🛠️ Endpoint for updating product
>
> ```http
> PUT /api/productos/:id
> ```
>
> 🛠️ Endpoint for deleting product
> ```http
> DELETE /api/productos/:id
> ```
---
🥤🍫 Sprint 4 - Deploy and Documentation
▶️ Deploy
>
> Deployment in Render
> 
>
>
> 🌐 Render Deployment URL: https://food-ordering-api-restful.onrender.com
▶️ API Documentation
>
> Documentation in Swagger
> 
>
>
> 📓 API Documentation URL: https://app.swaggerhub.com/apis/ALANRIOSHD/api-res_tful_para_el_sistema_de_pedidos_de_comida_esfot/1.0.0