An API for a Gym checkin app.
See front-end here.
- sqlite3 driver
- node18+
Clone and run npm install inside the project's directory.
Run npm run dev. The API should be available at localhost:3000.
[en] Follow the instructions in Docs
[pt-br] Siga as instruções em Docs
[en] The project's requirements were broken in smaller tasks and organized in a board accessible HERE. A summary of the finished requirements from the original document can be found below as well.
[pt-br] Os requisitos do projeto foram quebrados em tarefas menores e organizadas em um quadro acessível AQUI. Um resumo dos requisitos concluídos do documento originail também pode ser encontrado abaixo.
- Deve ser possível se cadastrar (Nome, E-mail e Senha); ✅
- Deve ser possível se autenticar (E-mail e Senha);✅
- Deve ser possível cadastrar uma academia (Nome, Descrição, Telefone, Latitude e longitude); ✅
- Deve ser possível o usuário realizar check-in em uma academia; ✅
- Deve ser possível obter o perfil de um usuário logado;
- Deve ser possível o usuário obter o seu histórico de check-ins; ✅
- Deve ser possível o usuário buscar academias pelo nome; ✅
- O usuário não deve poder se cadastrar com um e-mail duplicado; ✅
- O usuário não pode fazer 2 check-ins no mesmo dia; ✅
- A academia só pode ser cadastrada por administradores; ✅
- A senha do usuário precisa estar criptografada;✅
- Todas listas de dados precisam estar paginadas com 20 itens por página; ✅
- O usuário deve ser identificado por um JWT (JSON Web Token);✅
[en] "Clean" MVC with a service layer between the model and the controller.
[pt-br] MVC "limpo" com uma camada de serviços entre o model e o controller.
[en] To avoid the intentional storage of potentially harmful data and incorrect data input, the methods of the express-validate package were employed for validations and sanitizations.
[pt-br] Para evitar requisições com conteúdo potencialmente maliciosos sejam enviados pela API foi utilizado os métodos do pacote express-validate.