GoBarber API

A simple project to barber shop manager.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development purposes.

Prerequisites

NodeJS

You need to install NodeJS on your computer before you can use "GoBarber". You can install NodeJS by following these instructions.

Once you have completed the installation process, try typing npm -v into your command line. You should get a response with the version of NodeJS.

Yarn

Once you have NodeJs instaled, you need to install Yarn. You can install Yarn by following these instructions.

After instalition, try typing yarn -v into your command line. You should get a response with the version of Yarn.

Docker

You need to install Docker on your computer before you can use "GoBarber". You can install Docker by following these instructions.

Once you have completed the installation process, try typing docker -v into your command line. You should get a response with the version of Docker.

If you are using Linux distributions, is recommended following these instructions to manage Docker as a non-root use.

PostgreSQL

You need to configure PostgreSQL on your computer before you can use "GoBarber". You can configure PostgreSQL by following these instructions.

MongoDB local or Atlas

You need to install and configure a MongoDB on your computer or have a connection string for a database in Atlas cloud.

You can install MongoDB by following these instructions (Mac and Windows).

Redis

You need to configure Redis on your computer before you can use "GoBarber". You can configure Redis by following these instructions.

REST API Client

Finally, you will need a rest api client to test "GoBarber". Examples:

• Insomnia
• Postman
• Advanced REST Client

It is recommended to install the extension ESLint, Prettier, EditorConfig and edit the code editor' settings:

  "files.eol": "\n",
  "editor.codeActionsOnSave": { "source.fixAll.eslint": true },

Deploy

After clone repository, go to folder and follow this steps:

• Run yarn to install dependencies;
• Create a postgres database;
• Create a mongo database;
• Create a redis database;
• Create a file .env based on the file .env.example;
• Put your credentials inside .env;
• Run yarn sequelize db:migrate to creat the migrations;
• Run yarn sequelize db:seed:all to creat the seed;
• Run yarn dev to start de aplication;
• Run yarn queue in another terminal to start de queue.

Now you can use your REST API Client to test "GoBarber".

Built With

• NodeJS
• Docker
• PostgreSQL
• Mailtrap.io
• Redis
• Sentry.io

Tools

• Sucrase + Nodemon;
• ESLint + Prettier + EditorConfig;
• Sequelize

Authors

• Matheus Leandro

License

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

Based on Rocketseat Bootcamp 🚀