🗄️ README.md

📝 Descrição

Projeto de criação de uma API para Estudos de consumo pelo Metodo HTTP.

📚 Funcionalidades

• CRUD de Usuários

• Create (Criar Usuário): Permite criar um novo usuário no sistema.

• Read (Ler Usuário): Permite listar todos os usuários cadastrados, além de visualizar informações detalhadas de um usuário específico.

• Update (Atualizar Usuário): Permite atualizar as informações de um usuário existente.

• Delete (Deletar Usuário): Permite excluir um usuário do sistema.

🔧 Tecnologias utilizadas

• Express;

npm install express

• Mongoose - MongoDB

npm install mongoose

• Bcrypt

 npm install bcrypt

• Cors

 npm install cors

• Dotenv

 npm install dotenv

• Mongoose-paginate-v2

 npm install mongoose-paginate-v2

• Nodemon

 npm install nodemon

• Jsonwebtoken

 npm install jsonwebtoken

• Swagger UI Express

 npm i swagger-ui-express

• swagger-jsdoc

 npm i swagger-jsdoc

🚀 Rodando o projeto

Para rodar o repositório é necessário clonar o mesmo, dar o seguinte comando para iniciar o projeto:

 npm run dev 

Comando para iniciar o seed com dados para popular o banco:

 npm run seed

Comando para iniciar os testes unitarios e de integração:

 npm run teste 

 npm run teste:v

 npm run teste:coverage

🤝 Colaboradores

• Alexandre

🎯 Status do projeto

• Finalizado