README.md

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
  • TypeORM
  • styled-components
  • Unform
• 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.

Prerequisites

You will need to install Git, Docker Desktop and Docker Compose before following the instructions below.

Setting up the development environment

The following steps need to be performed inside a terminal window (Windows user may prefer to use the Windows Terminal but the Command Prompt will also work).

Clone the repository and build Docker images:

# Clone repository
git clone https://github.com/diegomais/gobarber-ts.git

# Change directory
cd gobarber-ts

# Build Docker images
docker-compose build

# Create .env from example file
if [ ! -f $PWD/backend/.env ]; then cp $PWD/backend/.env.example $PWD/backend/.env; fi

# Apply database migrations
docker-compose run --rm backend yarn typeorm migration:run

Running application containers

Use the following command to run all GoBarber containers (from within the gobarber-ts directory):

# Start containers
docker-compose up

Mobile

Prerequisites

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.

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 mobile directory:

npm install
npm start

or

yarn install
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 👋.