FastFeet API Server 📨

NodeJS API developed on RocketSeat GoStack Bootcamp. Check the Web Version and the Mobile Version made with React Native.

• FastFeet API Server 📨
  • About
  • Technologies
  • How To Use
  • License
  • Author

About

This project is based on an application for a shipping company with admin authentication, recipients, deliveryman and orders management.

Technologies

This project was developed with the following technologies:

• NodeJS
• Express
• Multer
• JSON Web Token
• PostgreSQL
• date-fns
• Cors
• bcrypt.js
• bee-queue
• Nodemailer
• Sequelize v6
• Yup
• Sucrase
• Nodemon
• ESLint
• Prettier
• Editor Config

How To Use

Import the Insomnia_fastfeet.json on Insomnia App

To clone and run this application, you'll need:

• Git
• Node.js
• Yarn v1
• One instance of PostgreSQL.

Obs.: I recommend use docker.

Follow the steps below:

# Clone this repository
$ git clone https://github.com/rafacdomin/fastfeet-api

# Go into the repository
$ cd fastfeet-api

# Install dependencies
$ yarn

# Create the instance of postgreSQL using docker
$ docker run --name fastfeet-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=fastfeet -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Create the instance of redis using docker
$ docker run --name fastfeet-redis -p 6379:6379 -d -t redis:alpine

Make a copy of .env.example to .env and set YOUR enviroment variables

# Run the server
$ yarn dev

License

This project is under the MIT license. See the LICENSE for more information.

---

Author

Made with 💜 by Rafael Domingues 👋 Get in touch!