Skip to content

RESTful API of a fictitious cargo transport company

License

Notifications You must be signed in to change notification settings

Nouani/FastFeet-API

Repository files navigation

FastFeet-Logo

> RESTful API of a fictitious cargo transport company.


GitHub top language GitHub language count Codacy grade Repository size GitHub last commit Repository issues GitHub

Description   |    How To Use   |    References   |    Author Info   |    License

📃 Description

This API was developed to be used in a web / mobile application for a fictitious cargo transport company. It was developed in the GoStack bootcamp. The objective was to put into practice the concepts of RESTful API using a relational database (SQL) and one of the KEY / VALUE type.

We use Sequelize to connect to PostgreSQL and we also use Redis to optimize the sending of emails through queues. We also apply the MVC architecture type and JWT authentications together with Middlewares.

Remember that we did as many validations as possible on each route, always using HTTP responses.

🚀 Technologies

  • Docker
  • PostgreSQL
  • NodeJS
  • ExpressJS
  • Sequelize
  • Multer
  • JWT
  • Yup
  • Nodemailer
  • Handlebars
  • ESLint
  • Prettier
  • EditorConfig

ℹ️ How To Use

# Clone this repository
$ git clone https://github.com/Nouani/FastFeet-API.git

# Go into the repository
$ cd FastFeet-API

# Install dependencies
$ yarn

# Run the app
$ yarn dev

# Run the queues with redis
$ yarn queue

Note: You must have installed the Yarn package manager globally. In addition, a PostgreSQL and Redis database (I recommend Docker). To test sending emails use the Mailtrap. Finally, set the environment variables using the ".env.example" file as a base.

📘 References

:person_with_blond_hair: Author Info

📝 License

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

About

RESTful API of a fictitious cargo transport company

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published