A motivação do projeto se deu pela recente tragédia da enchente no Recife, estado que morei por 21 anos. Com isso, pessoas próximas entraram em contado com meus pais no intuito de alugar a nossa antiga casa, pois estavam desabrigados e não gostariam de retornar para locais com grandes focos de alagamentos, ou que a rua não fosse asfaltada. Isso me fez pensar em desenvolver uma API REST de moradia específica para a capital do Nordeste, onde as famílias pudessem entrar no site e buscar por casas e apartamentos que fossem mais adequados para a sua situação financeira e sem risco de alagamento.
API desenvolvida como projeto final do curso de backend da {Reprograma}. Tem como objetivo ajudar pessoas desabrigadas na capital do Nordeste que ficaram em situação de vunerabilidade após a tragédia da enchente, e que de acordo com o 'Portal Folha de Pernambuco', Recife tem 3.828 famílias desalojadas, segundo o balanço da prefeitura.
- Cors
- Nodemon
- Mongoose
- Express
- Dotenv
-
Entre no terminal do Git Bash e faça o clone da APIaluguel:
git clone https://github.com/llinesobral/APIaluguel
-
Faça o
fork
:
-
Faça o
clone
: -
Instale as
dependências
: -
Crie o seu
.env
e inclua as variáveis e valores: -
Utilize
Postam
para chamar e testar os endpoinst da API:
-
GET
- Lista das moradias:
localhost:7070/pe/all
- Lista dos bairros:
localhost:7070/pe/district
- Lista de locais com focos de alagamentos:
localhost:7070/pe/flooding
- Lista das moradias:
-
POST
- Cadastro de novas moradias:
localhost:7070/pe/register
- Cadastro de novas moradias:
-
PUT
- Atualizando os dados:
localhost:7070/pe/update/:id
- Atualizando os dados:
-
DELETE
- Exclue moradias já ocupadas:
localhost:7070/pe/remove/:id
- Exclue moradias já ocupadas:
- Listar todas as moradias cadastradas no sistema;
- Listar todas as localidades com foco de alagamento;
- Listar por valores de aluguel casas e apartamentos;
- Listar por bairro;
- Cadastrar novas moradias;
- Atualizar os dados das moradias;
- Deletar moradias já ocupadas.
- JavaScript
- Node.js
- Vscode
- Git/Github
- MongoDb
- Postman
- Heroku
-
O projeto final consiste em uma API fundamentada no
CRUD
:- CREATE (CRIAR),
- READ(LER-CONSULTA),
- UPDATE(ATUALIZAR),
- DELETE(DELETAR).
-
E também na
Arquitetura MVC
:
├── 📁APIaluguel
│ ├─ 📁src
│ │ ├─ 📁controller
│ │ │ └─ 📑rentController.js
│ │ ├─ 📁database
│ │ │ └─ 📑mongoConfig.js
│ │ ├─ 📁models
│ │ │ └─ 📑Recifehousing.js
│ │ ├─ 📁routes
│ │ │ └─ 📑rentRouter.js
│ │ └─ 📑app.js
│
│ ├─ 📑.env
│ └─ 📑.env.example
│ ├─ 📑package-lock.json
│ └─ 📑package.json
│ ├─ 📑Procfile
│ └─ 📑README.md
│ └─ 📑server.js
Aline Alves de Lima Sobral.
-
Linkedin: https://www.linkedin.com/in/aline-alves-5b7660235/
-
Instagram: https://www.instagram.com/lline.22/