An open API service indexing awesome lists of open source software.

https://github.com/jerp86/gobarber

:fire: GoBarber back-end :rocket:
https://github.com/jerp86/gobarber

Last synced: 9 months ago
JSON representation

:fire: GoBarber back-end :rocket:

Awesome Lists containing this project

README

          


GoStack

# :rocket: GoBarber Back-end :fire:


GitHub language count


Made by Jerp

License


Stargazers


About the Project   |   
Technologies   |  
Installation and Execution   |  
Insomnia   |  
How to Contribute   |  
License

## :rocket: About the Project

GoBarber is an application aimed at the use of service providers in general, such as barber shops, beauty salons, manicures, among others.

Through GoBarber Web it is possible to register providers and their services, consult and control their service schedule.

Through GoBarber Mobile, with a simple registration, each customer can search for the service they are interested in and make the scheduling quickly and conveniently.

In order to have all these resources both on the Web and on Mobile, the Back-end is responsible for making all of these resources available for registration, consultation and scheduling.

The [GoBarber] Back-end will be a [RESTFul][rest] API developed in [Node.js][nodejs] and a few libs listed below.

## :rocket: Technologies

This project was developed at the [RocketSeat GoStack Bootcamp](https://rocketseat.com.br/bootcamp) with the following technologies:

- [Node.js][nodejs]
- [Express]
- [Sucrase]
- [Nodemon]
- [Yarn]
- [NPM]
- [ESLint]
- [Prettier]
- :card_index: [Editor Config][vceditconfig]
- [Sequelize]
- :elephant: [PostgreSQL]
- :closed_lock_with_key: [BCrypt]
- :key: [JWT]
- :heavy_check_mark: [Yup]
- :card_index: [VS Code][vc]
- :dart: [Insomnia]

## :fire: Installation and Execution

1. Clone this repository;
2. Enter the folder by running `cd GoBarber`;
3. Run `yarn` or `npm install` to install the dependencies;
4. Run `yarn dev` or `npm run dev` to start the server.

## :dart: Insomnia
[![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Test%20API&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fjerp86%2FGoBarber%2Fmaster%2FInsomnia.json)

## :thinking: How to Contribute

1. Fork this repository;
2. Create a branch with your feature: `git checkout -b minha_feature`;
3. Commit your branch: `git commit -m "feature: My new feature"`;
4. Push to your branch: `git push origin minha_feature`.

## :memo: License

This project is under the MIT license. See the [LICENSE](https://github.com/jerp86/GoBarber/blob/master/LICENSE) for more information.

---

Made with ♥ by Jerp :wave: [Get in touch!][jerp]

[nodejs]: https://nodejs.org/
[express]: https://expressjs.com/
[yarn]: https://yarnpkg.com/
[npm]: https://www.npmjs.com/
[vc]: https://code.visualstudio.com/
[vceditconfig]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
[jerp]: https://www.linkedin.com/in/jerp/
[insomnia]: https://insomnia.rest/
[sucrase]: https://sucrase.io/
[nodemon]: https://nodemon.io/
[sequelize]: https://sequelize.org/
[postgresql]: https://www.postgresql.org/
[bcrypt]: https://github.com/dcodeIO/bcrypt.js
[jwt]: https://jwt.io/
[rest]: https://pt.wikipedia.org/wiki/REST
[GoBarber]: https://github.com/jerp86/GoBarber
[ESLint]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
[Prettier]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
[Yup]: https://github.com/jquense/yup