Food Explorer - API Restful

Status: Finished

About • Features • Layout • Tech Stack • Author • License

---

💻 About

API Restful - The application that we will develop is a digital menu for a fictional restaurant, known as foodExplorer.

In this challenge, the following topics were addressed:

• Express;
• Routes and http method;
• Params;
• Controllers;
• Middleware;
• SQL;
• Migrations;
• Query Builder;
• Knex;
• JWT;
• Disk Storage;
• Cors;

---

⚙️ Features

• A structured project, with a good organization of folders, division of components in the front-end, etc.
• A README.md file with specifications on how to run the project in a dev environment.
• Users must authenticate themselves to enter the application through the login screen, you can apply what you learned in JWT authentication classes. Authentication must be validated with a password.
• The admin will upload images to register the dishes.
• Finally, deploy your application.
• Give your functions and variables meaningful names: work with Clean Code concepts a bit.
• The admin, restaurant and users data will be stored in a database.
• Possibility to search by dish name, ingredients or favorite dish
• It is essential that your interface consumes its own API.
• Interesting to make the application responsive: use the concept of Mobile First that was learned in class.
• It's up to you where to apply animations, transitions, and transformations.
• It meets the model proposed in Figma and contains elements indicative of action and state. opcionais
• The user can add items to the cart by clicking the add button. The amount is controlled by the “-” and “+” buttons;
• By clicking on the my order button, the user will be redirected to a screen where he will see his order, the sum and the payment methods;
• The user will be able to delete a dish from the cart and the total amount of the order should be updated automatically;
• The user can mark a dish as a favorite, just click on the heart that appears next to each one;
• The admin will view and control the status of each order, through a select field. Orders will appear in a table when you click Orders;

---

🚀 How it works

This project is divided into three parts:

1. Backend (food-explorer-backend folder)
2. Frontend (food-explorer-frontend folder)

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

🎲 Running the Server (Backend)

# Clone this repository
$ git clone git@github.com:exodogurgel/food-explorer-backend.git

# Access the project folder in your terminal
$ cd food-explorer-backend

# Install the dependencies
$ npm install

# run the migration and seed
$ npm migrate
$ npm seed

# Run the application in development mode
$ npm run dev

# Admin login
$ email: admin@email.com
$ password: 090807

# The Server will start at port: 3333 - go to http://localhost:3333

---

🛠 Tech Stack

The following tools were used in the construction of the project:

• Express
• CORS
• KnexJS
• SQLite
• Node
• Multer

---

💻 Project

The application that we will develop is a digital menu for a fictional restaurant, known as foodExplorer.

🦸 Author

_{Êxodo Gurgel} 🚀

---

📝 License

This project is under the license MIT.

Made with ❤️ by Êxodo Gurgel 👋🏽 Get in Touch!

---