RodrigoSaantos/gobarber-backend

Express Application for GoBarber project

The best way to schedule your service!

Application developed in the bootcamp of Rocketseat GoStack#14 💻🚀

Objective • Technologies • Usage • Contribution • Author • License

🎯 Objective

This api provides everything needed to organize appointments between the barbers and customers.

Customers can choose the best time available to them.

Providers can see all their appointments, manage the times, also see if one client canceled the schedule.

To see the web client, click here: GoBarber Web
To see the mobile client, click here: GoBarber Mobile

🛠 Technologies

The following tools were used in the construction of the project:

• Node.js
• TypeScript
• Express
• Multer
• TypeORM
• JWT-token
• uuid v4
• PostgreSQL
• Date-fns
• Jest
• SuperTest
• Husky
• Commitlint
• Commitizen
• Eslint
• Prettier
• EditorConfig

👷 Usage

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn or npm
• One instance of PostgreSQL

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/RodrigoSaantos/gobarber-backend.git && cd gobarber-backend

Follow the steps below

# Install the dependencies
$ yarn
# or
$ npm install

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# Create the instance of postgreSQL using docker
$ docker run --name gobarber-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=gobarber -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Create the instance of mongoDB using docker
$ docker run --name gobarber-mongodb -p 27017:27017 -d -t mongo

# Create the instance of redis using docker
$ docker run --name gobarber-redis -p 6379:6379 -d -t redis:alpine

# Once the services are running, run the migrations
$ yarn typeorm migration:run

# To finish, run the api service
$ yarn dev:server

# Well done, project is started!

🤝 Contribution

This project is for study purposes too. All kinds of contributions are very welcome and appreciated!

• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'feat: My new feature';
• Push to your branch: git push origin my-feature.

💻 Author

By Rodrigo Santos 👋🏽 Find me:

|

📝 License

This project is licensed under the MIT License

---