API for GoBarber

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

💇🏻‍♂✂ About the project

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 and manage the times.

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

💻🛠 Technologies

Technologies that I used:

• TypeScript
• Node.js
• Express
• Multer
• TypeORM
• JWT-token
• uuid v4
• PostgreSQL
• Redis
• MongoDB
• Date-fns
• Jest
• Eslint
• Prettier
• EditorConfig

💻🖥 Getting started

Requirements

• Node.js
• Yarn or npm
• Instances of PostgreSQL, MongoDB and Redis

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

Follow the steps below

# Install the dependencies
$ yarn
# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ 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
# Make a copy of 'ormconfig.example.json' to 'ormconfig.json'
# and set the values, if they are not filled,
# to connect with docker database containers
$ cp ormconfig.example.json ormconfig.json
# 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!

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork ruandsx/gobarber-backend

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd gobarber-backend
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new awesome feature'
# Send the code to your remote branch
$ git push origin my-feature

📝 License

This project is licensed under the MIT License

---

Made with 💛 by 👨‍💻Ruan Xavier