Skip to content

Api for the Gobarber Application. Application developed during GoStack - Rocketseat 💜

License

Notifications You must be signed in to change notification settings

J-Keven/gobarber-api

Repository files navigation

GoStack

GitHub language count License Stargazers Stargazers

Sobre   |    Requisitos   |    Como Usar   |    Como Contribuir   

💈Sobre

O Gobarber é uma aplicação para agendamento de horários em barbearia, onde um cabeleleiro/barbeiro pode cadastrar um horári disponível e o cliente poderá agendar um horário com o cabeleleiro/barbeiro 💈.

🔥Requisios

Para ver os requisitos da aplicação click aqui

🔥Como usar

  • Pré-requisitos

    • É necessário possuir o Node.js v12x instalado na máquina
    • Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.
    • É importante que tenha um banco Sql rodando na sua máquina, de preferência postgreSQL.
  1. Faça um clone :
  $ git clone https://github.com/J-Keven/gobarber-api.git
  1. Entre na pasta da aplicação:
  $ cd gobarber-api
  1. Alterando as informações de conexão com o Banco:
  • Abra o arquivo ormconfig.json e coloque as informaçõe do seu banco. Ex:
{
  "type": "postgres",//tipo de banco, postgres, mysql
  "host": "localhost",//onde está sedo executando o banco
  "port": 5432,
  "username": "postgres",
  "password": "docker",
  "database": "gobarber",//nome do banco
}
  1. Instale as depedências:
  # Instale as dependências
  $ yarn
  1. Executando a Aplicação:
  # Inicie a API no mode de dev
  $ yarn dev:server

  # Inicie a API no ambiente de produção
  $ yarn start

🚀 Como contribuir

  • Faça um fork desse repositório;
  • Cria uma branch com a sua feature: git checkout -b minha-feature;
  • Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
  • Faça push para a sua branch: git push origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

📝Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.


Feito com 💜 by J-keven 👋 Entre na nossa comunidade!

About

Api for the Gobarber Application. Application developed during GoStack - Rocketseat 💜

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published