pedro-drosa/fastfeet-api

🚚 Rest api for fastfeet application - made with express framework - using docker, postgreSQL and sequelize

Express Application for FastFeet project

A fast way to manage delivery companies!

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

🚚 About the project

With this API is possible to manage users, recipients, delivery man and everything what is needed for the delivery flow.

To confirm the delivery was finished, the delivery man must send a recipient signature photo. This is one of the application business rules.

To see the web client, click here: FastFeet Web
To see the mobile client, click here: FastFeet Mobile

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• Express
• Sequelize
• Mongoose
• PostgreSQL
• MongoDB
• Docker
• Docker Compose
• Multer
• Nodemailer
• Handlebars
• JWT-token
• Bee-Queue
• Yup
• Date-fns
• Nodemon
• Sucrase
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn or npm
• Docker and Docker Compose

Clone the project and access the folder

$ git clone https://github.com/EliasGcf/fastfeet-api.git && cd fastfeet-api

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env

# Start the services with docker-compose
$ docker-compose up -d

# Once the services are running, run the migrations
$ yarn sequelize db:migrate

# Run the seed to create the 'admin-user'
$ yarn sequelize db:seed --seed 20200212180839-admin-user.js

# Well done, project is started!

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork EliasGcf/fastfeet-api

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd fastfeet-api

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Elias Gabriel 👋  See my linkedin