Mochidicas - Projeto Final {Reprograma}

• 🗺️ {Mochidicas}
• 📁 Arquitetura MRC
• 💻 Tecnologias E Pacotes Usados
• 💻 Instalação
• 🔐 Rotas/Endpoints
• Autora

{Mochidicas}

A ideia é uma API contendo CRUD completo, banco de dados, autenticação e login, que põe em prática os conhecimentos adquiridos nas últimas 18 semanas, e que contribua para uma página de viagens, ou um blog, ou o que quer que seja que se utilize da API de forma útil. Esta API deve ser aperfeiçoada e estou aberta a sugestões, pois continuarei meu processo de estudos para melhorá-la.

O que será possível fazer com a API

• Criar uma dica
• Ler todas as dicas já cadastradas
• Ler dicas especificadas por cidade
• Ler dicas especificadas por estado
• Ler dicas especificadas por temporada (Primavera-Verão-Outono-Inverno-Todas)
• Modificar alguma dica sua
• Deletar sua dica

Arquitetura MRC

 📁 Mochidicas-Reprograma-ProjetoFinal
   |
   |- 📁 src
   |   |
   |   |- 📁 controllers
   |       |- 📑 dicasController.js
   |       |- 📑 perfilController.js
   |       |- 📑 usuarioController.js
   |
   |   |- 📁 database
   |       |- 📑 mongooseConect.js
   |
   |   |- 📁 models
   |       |- 📑 dicasModel.js
   |       |- 📑 perfilModel.js
   |       |- 📑 usuarioModel.js
   |
   |    |- 📁 routes
   |       |- 📑 dicasRoutes.js 
   |       |- 📑 index.js
   |       |- 📑 perfilRoutes.js   
   |       |- 📑 usuarioRotas.js
   |
   |    |- 📑 app.js
   |
   |- 📁 swagger
   |   |- 📑 swagger_output.json
   |
   |- 📑 .env
   |- 📑 .env.example
   |- 📑 .gitignore
   |- 📑 package-lock.json
   |- 📑 package.json
   |- 📑 Procfile
   |- 📑 README.md
   |- 📑 server.js
   |- 📑 swagger.js

Tecnologias e pacotes usados

JavaScript | Node.js | Git | VSCode | Mongodb | Heroku | Postman

Dependências necessárisa:

• nodemon
• bcrypt
• cors
• dotenv
• express
• jsonwebtoken
• mongoose
• swagger-autogen
• swagger-ui-express

Instalação

Se você quiser ter essa APi na sua máquina, será necessário:

# Clonar o repositório
$ git clone https://github.com/ChrisAnDias/Mochidicas-Reprograma-ProjetoFinal.git

# Entrar na pasta do repositório
$ cd Mochidicas-Reprograma-ProjetoFinal

# Instalar as dependências
$ npm install

# Executar o servidor
$ npm start

Rotas/EndPoints:

• Usuario

Verbo	EndPoint	Descrição da Rota	Status	Auth
POST	/usuarios/criar	Criar um novo usuário	201	✔️
GET	/usuarios	Listar todas colaboradoras	200	❌
POST	/usuarios/login	Retornar um token de um usuário	200	✔️
DELETE	/usuarios/:id	Remover um usuário	200	✔️

• Perfil

Verbo	EndPoint	Descrição da Rota	Status	Auth
POST	/perfil/criar	Criar um novo perfil	201	✔️
GET	/perfis	Listar todos os perfis	200	✔️
GET	/perfil/:id	Listar perfis por ID	200	✔️
PATCH	/perfil/:id	Atualizar o cadastro de um perfil	200	✔️
DELETE	/perfil/:id	Remover o cadastro de um perfil	200	✔️

• Dicas de viagem

Verbo	EndPoint	Descrição da Rota	Status	Auth
POST	/dica	Criar uma dica	201	✔️
GET	/listarDicas	Retorna todas as dicas já cadastradas	200	❌
GET	/dicas/cidade	Listar dicas por cidade especificada	200	❌
GET	/dicas/estado	Listar dicas por estado especificado	200	❌
GET	/dicas/temporada	Listar dicas por temporada especificada	200	❌
PATCH	/attdica/:id	Atualiza uma dica	201	✔️
DELETE	/deleteDica/:id	Remover uma dica cadastrada	200	✔️

Link para a documentação:

📝 Swagger

📝 Heroku

Autora

Desenvolvido por

Há 18 semanas eu sabia zero de programação, hoje tenho aqui o resultado de um belo trabalho colaborativo de mulheres incríveis que me ajudaram a reprogramar parte da vida.
Obrigada a todas.