README.md

The best way to schedule your service!

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

💇🏻‍♂️ About the project

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

• Customers can choose the best time available to them.

• Providers can see all their appointments and manage their schedule.

🚀 Technologies

Technologies used to develop this application

API	Web	Mobile
Node.js	ReactJS	React-native
TypeScript	Typescript	Typescript
Express	Axios	Axios
Multer	Styled-components	Styled-components
TypeORM	Polished	Date-fns
JWT-token	Date-fns	React-native-image-picker
uuid v4	React-day-picker	React-native-datetime-picker
PostgreSQL	React-icons	React-native-vector-icons
Date-fns	React-spring	Unform
Jest	Unform	Jest
SuperTest	Jest	Yup
Husky	Yup
	uuid v4

💻 Getting started

Requirements

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

Obs.: Docker recommended

Clone the project and access the main folder

$ git clone https://github.com/cassiogroh/GoBarber && cd GoBarber

# Install the dependencies
$ yarn

Follow the steps below on folder packages/server

# 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=gostack_gobarber -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

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

# Create the instance of redis using docker
$ docker run --name 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, server started!

# Start web client
$ yarn start

# Start mobile client
$ yarn android / yarn ios

# Well done, project is running!

🤔 How to contribute

Fork this repository

# Fork using GitHub command line or trhough website

$ gh repo fork cassiogroh/GoBarber

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd GoBarber

# 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-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Cassio Groh 👋  See my linkedin