GoBarber API

Plataforma de agendamento e gerenciamento para barbearias

Sobre o projeto | Tecnologias | Guia de instalação e execução | Como contribuir | Licença

Layout

🚀 Sobre o projeto

Esta é uma plataforma completa onde o cliente pode visualizar a agenda de barbeiros e agendar um horário, e para barbeiros, permite gerenciar os horários marcados.

Este é o repositório da API do projeto.

• Para a versão web, clique aqui.
• Para a versão mobile, aqui.

💻 Tecnologias

Além das tecnologias abaixo, esta aplicação foi desenvolvida com as melhores práticas de desenvolvimento!

😍 TDD 💖 Design patterns: SOLID, DDD e DRY, ⚖️ estratégia de cache e 🚓 segurança no node.

• Node.js
• Express
• Typescript
• ESLint-Airbnb, Prettier e EditorConfig
• Celebrate
• Jest
• Multer
• Datefns
• Dotenv
• Bcrypt.js
• Jsonwebtoken
• TypeORM
• Handlebars
• Nodemailer
• Ioredis
• Cors
• Aws-sdk
• Class-transformer
• Rate-limiter-flexible
• Tsyringe
• Uuidv4

📚 Guia de instalação e execução

Pré-requisitos

• Git
• Node.js v10.20 ou maior
• Yarn
• Uma instância de PostgreSQL, Mongodb e Redis **

** Ou Docker

Como executar

Antes de executar estes passos, você precisa ter uma instância dos bancos listados acima ou um Docker com as imagens e os databases e schemas criados.

• Clone o repositório git clone https://github.com/nathaliacristina20/gostack-gobarber-server.git
• Vá até o diretório cd gostack-gobarber-server
• Execute yarn para instalar as dependências
• Copie o arquivo .env.example executando cp .env.example .env para linux ou mac e copy .env.example .env para windows
• Abra o arquivo .env e preencha com suas variáveis de ambiente
• Copie o arquivo de configuração do orm executando cp ormconfig.example.json ormconfig.json para linux ou mac e copy ormconfig.example.json ormconfig.json para windows
• Abra o arquivo ormconfig.json e preencha com suas credenciais das instâncias dos bancos de dados
• Execute yarn typeorm migration:run para rodar as migrations
• Execute yarn dev:server para rodar o servidor

Você pode realizar requisições REST através do Insomnia

Caso deseje executar os testes unitários e de integração basta executar yarn test em seu terminal. Você poderá ver um relatório da cobertura acessando o arquivo coverage/lcov-report/index.html.

📝 Como contribuir

Faça um fork deste repositório

# Clone o seu fork
$ git clone url-do-seu-fork && cd gostack-gobarber-server

# Crie uma branch com sua feature ou correção de bugs
$ git checkout -b minha-branch

# Faça o commit das suas alterações
$ git commit -m 'feature/bugfix: minhas alterações'

# Faça o push para a sua branch
$ git push origin minha-branch

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.

---

by Nathalia Cristina 👋 Get in touch!