joaoathaide / gobarber-api-server

GoBarber API

A barber scheduling app that allows users to schedule an appointment with his favorite barber and shows to the barber his agenda for the day.

Technologies   |    Prerequisites   |    Getting started   |    Contributing   |    License

🚀 Technologies

This project was developed at the RocketSeat GoStack Bootcamp with the following technologies:

• Node.js
• Express
• nodemon
• Sucrase
• Docker
• Sequelize
• PostgreSQL
• node-postgres
• Redis
• MongoDB
• Mongoose
• JWT
• Multer
• Bcrypt
• Youch
• Yup
• Bee Queue
• Nodemailer
• date-fns
• Sentry
• DotEnv
• VS Code with ESLint

Prerequisites

To run this server you will need three containers running on your machine.

To do so, you will need to run the following commands:

• docker run --name redisbarber -p 6379:6379 -d -t redis:alpine;
• docker run --name mongobarber -p 27017:27017 -d -t mongo;
• docker run --name some-postgres -e POSTGRES_PASSWORD=docker -p 5433:5432 -d postgres;

Remember: If you restart your machine, you will need to start again the server with docker start <container_id>.

Getting started

Consider checking out the FrontEnd repository!

1. Clone this repo using https://github.com/joaoathaide/gobarber-api-server.git
2. Move to the appropriate directory: cd gobarber-api-server.
   
3. Run yarn to install dependencies.
   
4. Run yarn sequelize db:migrate.
   
5. Copy the .env.example file and rename it to .env.
   
6. Add all the values for the environment variables.
   
7. Run yarn start and yarn queue to run the servers at http://localhost:3000.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

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

Made with ♥ by João Athaide