GoBarber: Barber shop booking 💈

Technologies   |    Getting started   |    How to contribute   |    License

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• React
• React Native

Extras:

• Main Libs
  • Express
  • Sequelize ORM
  • Redux
  • redux-saga
• Style
  • EditorConfig
  • ESLint
  • Prettier

💺 Getting started

These instructions will get you a copy of the full project up and running on your local machine for development and testing purposes.

Setting up the development environment

The project is developed using Git. Git is a free and open source distributed version control system. Download Git.

The project can be built with npm or Yarn, so choose one of the approach bellow in case you don't have any installed on your system.

• npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. Download Node.js.
• Yarn is a package manager built by Facebook Team and seems to be faster than npm in general. Download Yarn.

Cloning the project

You can obtain the project by running the instruction bellow on your terminal:

git clone https://github.com/diegomais/gobarber.git

Setting up Databases and Services

The project uses PostgreSQL, MongoDB and Redis.

We recommend use Docker to install and run the databases and services above.

1. Install Docker Desktop.
2. Start a PostgreSQL instance: docker run --name gobarber-pg -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres
3. Start a MongoDB instance: docker run --name gobarber-mongo -p 27017:27107 -d mongo
4. Start a Redis instance: $ docker run --name gobarber-redis -p 6379:6379 -d redis

API

Installing dependencies and running the server

Run the instructions bellow inside packages/api directory:

1. npm install
2. npm run dev

or

1. yarn install
2. yarn dev

Web

Installing dependencies and running the web application

Run the instructions bellow inside packages/web directory:

1. npm install
2. npm start

or

1. yarn install
2. yarn start

Mobile

Setting up the development environment

Follow the instructions for React Native CLI available in the official React Native Documentation.

Installing dependencies and running the mobile application

Run the instructions bellow inside packages/mobile directory:

1. npm install
2. npm start

or

1. yarn install
2. yarn start

🤔 How to contribute

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

After the merge of your pull request is done, you can delete your branch.

📝 License

This project is under the MIT license. See the LICENSE for more details.

---

Made with ❤️ by Diego Mais 👋.