Diziano / gobarber-api

:scissors: API da aplicação de agendamento para barbearias

Projeto   |    Tecnologias   |    Como contribuir   |    Como configurar e executar   |    Licença

💻 Projeto

O GoBarber é um aplicativo de agendamento para barbearias. Os clientes podem visualizar os horários disponíveis e agendar serviços com seu profissional favorito através do aplicativo. O profissional, através do site pode visualizar todos os seus próximos agendamentos e horários livres.

Este é um projeto de próposito didático que foi desenvolvido durante o Bootcamp GoStack da Rocketseat. Este repositório contempla somente a camada de Back-end da aplicação, uma API Rest. Confira a aplicação Web e Mobile nos links abaixo:

• GoBarber Web
• GoBarber Mobile

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• TypeScript
• Express
• TypeORM
• PostgreSQL
• Redis
• MongoDB
• celebrate
• Jest
• ESLint
• Prettier

🤔 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.

⚙️ Como configurar e executar

    # Clonar o repositório
    $ git clone https://github.com/diziano/gobarber-api.git

    # Navegar para o diretório
    $ cd gobarber

    # Instalar as dependências
    $ yarn 

• Renomeie o arquivo de configuração do TypeOrm: mv ormconfig.example.json ormconfig.json. No mesmo arquivo configure as credenciais do PostgreSQL e MongoDB;

• Renomeie o arquivo de configuração do ambiente: mv .env.example .env. No mesmo arquivo configure todas as variáveis de ambiente;

• No arquivo src/database/index.jsormconfig.json o nome do banco de dados dos testes (gofinances_tests);

• Para alterações do banco de dados aconselha-se utilizar a CLI do TypeORM: yarn typeorm {seu comando}. Confira a documentação aqui.

    # Executar migrations para criação das tabelas nas base de dados
    $ yarn typeorm migration:run

    # Iniciar o projeto
    $ yarn start

    # Iniciar o projeto em desenvolvimento
    $ yarn dev:server

    # Executar testes
    $ yarn test

📝 Licença

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

---

Made with 🖤 by Diziano