Giter Club home page Giter Club logo

apialuguel's Introduction

🚧 ..Projeto README em 🚀 construção... 💈

✍️ Descrição

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.

📚 Sobre o Projeto

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.

⚠️ Instalações

  • Cors
  • Nodemon
  • Mongoose
  • Express
  • Dotenv

💻 Como Usar

  1. Entre no terminal do Git Bash e faça o clone da APIaluguel:

    git clone https://github.com/llinesobral/APIaluguel

  2. Faça o fork:

clique no fork

  1. Faça o clone:

    git clone forcado

  2. Instale as dependências:

    instalando dependencias

  3. Crie o seu .env e inclua as variáveis e valores:

    criando o  env

  4. Utilize Postam para chamar e testar os endpoinst da API:

    postman  2

🔎 Rotas

  • GET

    • Lista das moradias: localhost:7070/pe/all

    Animação 1

    • Lista dos bairros: localhost:7070/pe/district

    Animação 2

    • Lista de locais com focos de alagamentos: localhost:7070/pe/flooding

    Animação 3

  • POST

    • Cadastro de novas moradias: localhost:7070/pe/register

    Animação 4

  • PUT

    • Atualizando os dados: localhost:7070/pe/update/:id

    Animação 5

  • DELETE

    • Exclue moradias já ocupadas: localhost:7070/pe/remove/:id

    Animação 6

⚙️ Funcionalidades/Objetivos

  • 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.

📱 Tecnologias Utilizadas

  • JavaScript
  • Node.js
  • Vscode
  • Git/Github
  • MongoDb
  • Postman
  • Heroku

📖 Aprendizados

  • 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

🎓 Autora

Aline Alves de Lima Sobral.

apialuguel's People

Contributors

llinesobral avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.