https://github.com/orodrigogo/gobarber-backend-ts
:satellite: API Restful para agendamentos de barbearia e prestações de serviços.
https://github.com/orodrigogo/gobarber-backend-ts
Last synced: 3 months ago
JSON representation
:satellite: API Restful para agendamentos de barbearia e prestações de serviços.
- Host: GitHub
- URL: https://github.com/orodrigogo/gobarber-backend-ts
- Owner: orodrigogo
- Created: 2020-04-16T18:56:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T17:09:55.000Z (almost 3 years ago)
- Last Synced: 2025-02-21T10:17:43.368Z (8 months ago)
- Language: HTML
- Homepage:
- Size: 1.12 MB
- Stars: 15
- Watchers: 3
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Sobre:
O **GoBarber** é uma plataforma WEB e MOBILE para agendamentos de serviços de barbearia.
A API do **GoBarber** serve a plataforma WEB e Mobile disponível para Android e iOS. :iphone:
### Importar rotas da aplicação:
Todas as rotas foram testadas utilizando o o do [Insomnia](https://insomnia.rest/download/). Para importar as rotas testadas para o Insomnia clique no botão:
[](https://insomnia.rest/run/?label=GoBarber&uri=https%3A%2F%2Fraw.githubusercontent.com%2Frodrigorgtic%2Fbackend-gobarber-typescript%2Fmaster%2Finsomnia-api-routes.json)
### Recursos da API:
:lock: **Recuperação de senha**
- [x] Permite que um usuário consiga recuperar a senha informando o e-mail cadastrado;
- [x] A API envia para o usuário um e-mail con instruções de recuperação de senha;
- [x] A API envia um link com token por e-mail para resetar a senha e por segurança o token enviado expira em 2h;
- [x] Cadastro e autenticação de usuários com geração de JwToken;
- [x] Autenticação de usuários com JwToken;
:busts_in_silhouette: **Atualização de perfil de usuário**
- [x] Permite usuário cadastrar-se e atualizar seu perfil (incluindo imagem de avatar);
- [x] Validação de e-mails no cadastro, não é possível cadastrar dois usuários com mesmo e-mail;
- [x] Para atualizar a senha, o usuário deve informar a senha antiga e a nova senha;
:computer: **Painel do Prestador de serviços (Barbeiro)**
- [x] Lista os agendamentos do prestador de serviços de um dia específico;
- [x] O prestador recebe uma notificação sempre que houver um novo agendamento;
- [x] O prestador pode visualizar as notificações não lidas;
- [x] A notificação possui estado de lida ou não-lida para que o prestador de serviços consiga gerenciar suas notificações;
- [x] Os agendamentos do prestador no dia também são armazenados em cache para acelerar o carregamento;
- [x] As notificações do prestador de serviço são armazenadas no MongoDB;
- [x] As notificações do prestador de serviço são enviadas em tempo real utilizando Socket.io;
:date: **Agendamento de serviços**
- [x] O usuário pode listar todos os prestadores de serviços cadastrado;
- [x] O usuário pode listar os dias de um mês com pelo meos um horário disponível de um prestador de serviço;
- [x] O usuário pode listar os horários disponíveis em um dia específico de um prestador;
- [x] O usuário deve poder realizar um novo agendamento com um prestador;
- [x] Por padrão, cada agendamento possui duração de 1h;
- [x] Os agendamentos estão disponíveis das 8h00 às 18h00 (Primeiro às 8h, último às 17h);
- [x] Os usuário não pode agendar um serviços em uma data ou horário que já passou;
- [x] O usuário não pode agendar serviços consigo mesmo;
- [x] A listagem de prestadores é armazenada em cache para acelerar o carregamento;
### Banco de Dados e estratégias de armazenamento:
Para banco de dados, foi utilizado o **Postgres** para armazenar os dados que envolvem relacionamentos da regra de negócio da aplicação, **MongoDB** para armazenar as notificações e **Redis** para lidar com filas de processamentos em segundo plano.
### Ferramentas, Técnicas e Bibliotecas da API:
- [x] Utilização dos Princípios do SOLID;
- [x] Aplicação da metodologia TDD (Test-driven development);
- [x] Utilização do [Jest](https://jestjs.io/) para automatização de testes no ambiente de desenvolvimento;
- [x] Utilização do [tsyringe](https://github.com/microsoft/tsyringe) para automatizar a injeção de dependência.
- [x] Utilizado o [mailtrap](https://mailtrap.io/) para testar o envio de e-mails em ambiente de testes;
- [x] Para envio de e-mail em produção será utilizado o Amazon SES;
- [x] O envio de e-mail acontece em segundo plano utilizando filas de processamento (background job);
- [x] Upload de imagens com Multer;
- [x] Utilização do MongoDD para armazenar notificações;
- [x] Utilização do Socket.io para envio de notificações em tempo real;
- [x] Utilizado do [Ethereal](https://ethereal.email/) que é um SMTP Fake para testar o envio de e-mails em ambiente de testes;
- [x] Utilizado do [Handlebars](https://handlebarsjs.com/) para template de e-mail em HTML5;
- [x] Utilização do [Celebrate](https://github.com/arb/celebrate) para validação de dados;
- [x] Utilização da biblioteca [dotEnv](https://www.npmjs.com/package/dotenv) para organizar as variaveis de ambiente da API;
- [x] Utilização da biblioteca [class-transformer](https://github.com/typestack/class-transformer) para definir os campos que deverão ser excluídos (como senhas) ou configurados (como link do avatar) nas entidades;
- [x] Utilização do driver [ioredis](https://github.com/luin/ioredis) para utilizar o Redis como cache de dados;
- [x] Utilização do [node-rate-limiter-flexible](https://github.com/animir/node-rate-limiter-flexible) para blindar a API contra ataques brute force;
- [x] Utilização da **Amazon S3** para upload de imagens;
- [x] Utilização da biblioteca [Mime](https://github.com/broofa/mime) para pegar o MIME extensão do arquivo (Ex: 'application/json', 'image/jpeg');
Rodrigo Gonçalves Santana - 2020