Rest API for Food Delivery Businesses, providing fast and clean service for providers and users.
- Features
- Installation
- Getting Started
- FAQ
- Found a bug? Missing a specific feature?
- Contributing
- License
- 🍽 Schedule appointments in restaurants
- 🛵 Request food orders
- 👩💼 Manage restaurants
- 📁 Files upload
- 👩🏻💻 Provider and user interface
You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:
git clone https://github.com/LauraBeatris/goeat-api.git
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:
git clone [email protected]:LauraBeatris/goeat-api.git
Install dependencies
yarn install
Create your enviroment variables based on the examples of .env.example
cp .env.example .env
After copying the examples, make sure to fill the variables with new values.
Setup a database
Install Postgres to create a database or if you have Docker in your machine, fill the environment values related to database configurations and then run the following commands in order to create a postgres container.
docker-compose up
Check if the containers are running
docker ps
Run the transactions in order to configure all the database schemas
npx sequelize-cli db:migrate
Run the following command in order to start the application in a development environment:
yarn dev
Run the following command to run the queue responsable for the mail job
yarn queue-dev
Run the following command in order to start the application in a production environment:
yarn start
Run the following command to run the queue responsable for the mail job
yarn queue
Question: What are the tecnologies used in this project?
Answer: The tecnologies used in this project are NodeJS + Express Framework to handle the server and Sequelize
Goeat returns the following status codes in its API:
| Status Code | Description |
|---|---|
| 200 | OK |
| 422 | UNPROCESSABLE ENTITY |
| 400 | BAD REQUEST |
| 404 | NOT FOUND |
| 500 | INTERNAL SERVER ERROR |
Feel free to file a new issue with a respective title and description on the the GoEat API repository. If you already found a solution to your problem, i would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.
Check out the contributing page to see the best places to file issues, start discussions and begin contributing.
Released in 2020. This project is under the MIT license.
Made with love by Laura Beatris 💜🚀