GoBarberApi

An awesome API to schedule hair cut services!


Report Bug | Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

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

Customers can schedule appointments, and providers can manage them.

Other features:

• DDD archteture and SOLID principles.
• Complete auth sessions.
• Cache With Redis.
• Nodejs is life 😄

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

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

(back to top)

Getting Started

First you need to download the Collection.json and import in insomnia. https://www.mediafire.com/file/8b5buibx7i80z0f/Collection/file

Prerequisites

• Node.js
• Yarn or Npm
• One instance of PostgreSQL. Using docker.

Installation

1. Clone the repo

   git clone https://github.com/MoisesGuedes/GoBarberApi.git

2. Install the dependencies

   yarn

3. Make a copy of '.env.example' to '.env
4. Set with YOUR environment variables
5. 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

6. Create the instance of mongoDB using docker

     docker run --name gobarber-mongodb -p 27017:27017 -d -t mongo

7. Create the instance of redis using docker

     docker run --name gobarber-redis -p 6379:6379 -d -t redis:alpine

8. Once the services are running, run the migrations

     yarn typeorm migration:run

9. Now you can the api service

     yarn dev:server

(back to top)