Gobarber API

Sobre   |    Tecnologias   |    Requisitos   |    Começando   |    Como Contribuir   

📃 Sobre

Este repositório contém a API REST em Node.js utilizando TypeScript referente à aplicação GoBarber desenvolvida no Bootcap GoStack da Rocketseat.

A API se refere a uma plataforma de agendamento de serviços para proprietários de barbearias ou salões de beleza. A aplicacao serve recursos para uma interface Web disponibilizando recursos para o usuário ter acesso a todos os prostadores de serviços cadastrados. Com isso, é possível escolher um determinado prestador para o agendamento na barbearia.

Já o prestador de serviço, através dq interface Web, consegue ter acesso a todos os seus horários, podendo ver todos os que estão ocupados quanto os que estão disponíveis.

🚀 Tecnologias

Tecnologias utilizadas no desenvolvimento da API:

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

📚 Requisitos

• Ter Git para clonar o projeto.
• Ter Node.js instalado.
• Ter Docker rodando um container PostgreSQL.

⚙️ Começando

  # Clonar o projeto:
  $ git clone https://github.com/samuelterra22/gobarber-api

  # Entrar no diretório:
  $ cd gobarber-api

  # Instalar as dependências
  $ yarn

  # Fazer uma copia do arquivo '.env.example' para '.env'
  # e configurar suas variáveis de ambiente.
  # As variáveis AWS não precisam ser preenchidas para o ambiente de desenvolvimento
  $ cp .env.example .env

  # Criar a instancia do postgreSQL usando docker
  $ docker run --name gobarber-postgres -e POSTGRES_USER=docker \
                -e POSTGRES_DB=gobarber -e POSTGRES_PASSWORD=docker \
                -p 5432:5432 -d postgres

  # Criar a instancia do mongoDB usando docker
  $ docker run --name gobarber-mongodb -p 27017:27017 -d -t mongo

  # Criar a instancia do Redis usando docker
  $ docker run --name gobarber-redis -p 6379:6379 -d -t redis:alpine

  # Assim que os serviços estiverem em execução, execute as migrations
  $ yarn typeorm migration:run

  # Para terminar, execute a aplicação
  $ yarn dev:server

🤔 Como contribuir

Faça um fork deste repositório

# Fork usando a linha de comando oficial do GitHub
# Se você não tiver a CLI do GitHub, use o site para fazer isso.

$ gh repo fork samuelterra22/gobarber-api

Siga os passos abaixo

# Clone seu fork
$ git clone your-fork-url && cd gobarber-api

# Crie uma branch com sua feature
$ git checkout -b my-feature

# Faça o commit com suas mudanças
$ git commit -m 'feat: My new feature'

# Envie o código para sua branch remote
$ git push origin my-feature

Depois que seu pull request for aceito e a feature estiver na branch principal, você pode deletar sua branch

Feito com ❤️ por Samuel Terra 👋🏻 Vamos de LinkedIn!