Uma API feita com NodeJS + ExpressJs.
Descrição • Documentação • Pré Requisitos • Começando • Instalação •
Para ver a API em funcionamento e ter uma breve explicação sobre o projeto assista o vídeo abaixo.
O vídeo estará disponível em breve.
Esta API gerencia e controla algumas entidades, são elas: Clientes, Endereços, Administradores e Permissões.Além disso, gera tokens de acesso, gerencia o sistema de login e criptografa as senhas cadastradas. O sistema foi todo construído em cima do NodeJs usando o framework ExpressJs. Além disso, no início as querys eram feitas no banco de dados através de strings, porém, com a complexidade aumentando o Sequelize foi escolhido e implantado como ORM do projeto. Existe um módulo de validação de CPFs e controle de duplicidade. O projeto conta com diversos middlewares que impedem erros e quebras de código.
Esta API está documentada seguindo o padrão Open API 3.0.0 e você pode encontrar a documentação no link abaixo:
A documentação foi criada utilizando Swagger e renderizada com o template Redoc. Em caso de dúvidas ou sugestões entre em contato.
- Git instalado
- NodeJS instalado
- NPM na última versão instalado
- Ser capaz de executar comandos por linha de comando (cmd ou power shell por exemplo).
Siga as instruções de instalação para rodar o projeto em sua máquina local. Em caso de dúvidas ou problemas entre em contato.
Aqui será considerado a instalação e execução do projeto por meio do sistema operacional Windows. Caso necessite executar este projeto em outro sistema operacional utilize o passo a passo trocando as variáveis do windows pelas de seu sistema operacional.
Passo 1-
Passo 2-
Passo 3-
Passo 4-
- Richard Smarsi - github.com/smarsi