Capacitação Backend CompJunior

Sobre • Requisitos mínimos • Para ir além • Tecnologias

Estrutura de diretórios • Como executar o projeto

✨ Sobre

Desafio desenvolvido para a capacitação de backend da CompJunior. CRUD para um aplicativo de contratação de faxineiros.

📌 Especificações mínimas

• O projeto deve ter no mínimo 1 schema e 1 controller;
• Deve conter no mínimo 1 CRUD completo;
• Documentação no Swagger;
• Deve ser possível testar todas as requisições;

🚀 Para ir além

• Criar usuário, com e-mail e senha e realizar login;
• Mandar imagem com foto do usuário na mesma rota em que ele é criado;
• Ter uma rota que só pode ser acessado com token de autenticação;
• Ter um usuário administrador que terá permissões diferentes de um usuário comum;
• Função de recuperar senha;
• Fazer com que o usuário receba um email automático;

⚡️ Tecnologias

• Node
• MongoDB
• Mongoose
• Express
• Nodemon
• Bcryptjs
• Crypto
• Swagger
• Nodemailer
• Slugify
• Multer
• Jsonwebtoken

🗃️ Estrutura de diretórios

├── assets
├── src
│   ├── app
│   │    ├── controllers
│   │    ├── middlewares
│   │    └── schemas
│   ├── config
│   ├── database
│   ├── modules
│   ├── resources
│   │    └── mail
│   │        └── auth
│   ├── utils
│   ├── index.js
│   ├── routes.js
│   ├── swagger.js
│   └── uploads
│       └── images

🤔 Como executar o projeto

🚨 Pré requisito

Antes de começar, você vai precisar ter instalado em sua máquina o Node.js.

# Clone este repositório
$ git clone https://github.com/mariaseverino/compjr-capacitacao.git

# Acesse a pasta do projeto
$ cd compjr-capacitacao

# Instale as dependências
$ npm install

# Execute a aplicação
$ npm start

# Rodando em http://localhost:3333

📝 Acessando documentação

# Acesse
http://localhost:3333/api-doc