The best way to schedule your service!
About the project | Technologies | Getting started | How to contribute | License
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 that I used to develop this api
- Node.js
- TypeScript
- Express
- Multer
- TypeORM
- JWT-token
- uuid v4
- PostgreSQL
- Date-fns
- Jest
- SuperTest
- Husky
- Commitlint
- Commitizen
- Eslint
- Prettier
- EditorConfig
Import the Insomnia.json on Insomnia App or click on Run in Insomnia button
- 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/EliasGcf/gobarber-api.git && cd gobarber-apiFollow the steps below
# Install the dependencies
$ yarn
# 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!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 EliasGcf/gobarber-apiFollow the steps below
# Clone your fork
$ git clone your-fork-url && cd gobarber-api
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new feature'
# Send the code to your remote branch
$ git push origin my-featureAfter your pull request is merged, you can delete your branch
This project is licensed under the MIT License - see the LICENSE file for details.
Made with 💜 by Elias Gabriel 👋 See my linkedin
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent