frndsjoao / GoBarber-backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

logo

API for GoBarber

Top language GitHub Made by

About the project   |    Technologies   |    Getting started

πŸ“„ About the project

Go to web here: GoBarber Web
Go to mobile client here: GoBarber Mobile

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

Gobarber is an application developed during GoStack Bootcamp, by Rocketseat, focused to learn the best use of ReactJS. I'm totally thankful to Rocketseat for the excellent bootcamp.

πŸ’» Technologies

Technologies that I used to develop this api

NodeJS   |    Typescript   |    Express   |    Multer   |    TypeORM   |    PostgreSQL   |    Jest   |    Eslint   |    Prettier

πŸ’» Getting started

⚠ Requirements

Clone the project and access the folder

$ git clone https://github.com/frndsjoao/GoBarber-backend.git && cd gobarber-backend

Then install the dependencies

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ 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

# Start the api service
$ yarn dev:server

πŸ“ License

Not specified.

About


Languages

Language:TypeScript 92.5%Language:JavaScript 6.6%Language:Handlebars 0.6%Language:Shell 0.2%