gabrielbarth/backend-gobarber

Backend (node.js) project of barber shop scheduling app :barber:

GoBarber (backend)

Backend (node.js) project of barber shop scheduling app 💈, developed during GoStack10 bootcamp.

💻 Web version here
📱 Mobile version here

🔎 Overview

This application allows:

• users authentication (barbers on web version and clients on mobile version);
• create and update users;
• create, list and removing appointments;
• notification of new appointments;
• e-mail notifications about cancelled appointments.

🔧 Some used tools

Insomnia

Allows testing API routes.

Postbird

Cross-platform PostgreSQL GUI client, written in JavaScript.

Sentry

Allows gebugging Node apps and prevent crashes across your entire stack.

Mailtrap

Allows inspect and debug your email samples before delivering them to your customers.

🔗 Project dependencies

☑️ sentry/node // exception handling in production mode
☑️ bcryptjs   // generate hash though user password
☑️ date-fns   // node library to handle data
☑️ bee-queue   // job/task queue for Node.js, backed by Redis
☑️ cors   // node.js package to enable CORS with various option
☑️ dotenv   // load environment variables in application paths
☑️ express   // basically allows create backend application
☑️ mongoose   // elegant mongodb object modeling for node.js
☑️ express-async-errors   // allows express capture errors that happens inside async functions
☑️ express-handlebars   // allows build semantic templates
☑️ jsonwebtoken   // allows generate jwt token for users
☑️ multer   // allows file uploads in application
☑️ nodemailer   // allow easy email sending
☑️ nodemailer-express-handlebars   // allows build semantic templates with nodemailer
☑️ path   // provides utilities for working with file and directory paths
☑️ pg   // allows use postgrees database
☑️ pg-hstore   // allows use postgrees database too
☑️ sequelize   // ORM Node.js for SQL databases (postgress in this case)
☑️ youch   // pretty error reporting for Node.js
☑️ yup   // treat validations

Development libs:

☑️ eslint // analyzes your code to quickly find problems
☑️ nodemon // allows automatically restarting app
☑️ prettier //code formatter, makes code prettier
☑️ sequellize-cli // sequelize client - ORM for SQL databases
☑️ sucrase // allows ES6 import/export modules

💻 Running on your machine

Consider the steps below to run this API on your machine:

First step: You'll need three docker containers running: redis, mongo and other to postgress.

This commands can create these docker containers:

• 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=mysecretpassword -p 5432:5432 -d postgres;

Some tips about docker:

• docker ps - list all docker containers (in execution).
• docker ps -a - list all docker containers (in execution or not).
• docker stop <container-name> - stops container execution.
• docker start <container-name> - starts container execution (required whenever you restart your machine).
• docker logs <container-name> - shows container log (used in errors case).

Second step: Clone this repository on your machine and do necessary configurations.

1. Clone this repo using https://github.com/gabrielbarth/backend-goBarber.git.
2. Move to the appropriate directory: cd backend-goBarber.
   
3. Run yarn to install dependencies.
   
4. Copy the .env.example file and rename it to just .env.
   
5. Add all the values for the environment variables on .env file.
   
6. Run yarn start and yarn queue to run the servers at http://localhost:3000.

💡 🤝 Contributing

Please feel free to contributing and submitting pull requests.

🙏 Acknowledgments

• Rocketseat team
• Rocketseat community

🤔 Any question?

Contact me on my social medias:
LinkedIn
Instagram
YouTube
Discord (gabrielbarth1#0492)
Or send me an email 📨: [email protected].

Made with ♥ by Gabriel Barth

backend-gobarber's Issues

.env.example

.env.example is missing ( added to gitignore)