/api-ecoleta

API desenvolvida com Node JS e Express e voltada para o controle de pessoas que desejam realizar o descarte adequado de materiais eletrônicos, seguindo os padrões REST

Primary LanguageJavaScript

API - ECOLETA

Descrição

API desenvolvida como Projeto Final para a conclusão do curso de Backend {Reprograma}.

Quem nunca ouviu os mais velhos falarem que antigamente os produtos duravam mais? 🤔
Basta uma rápida pesquisa no Google e vemos que não é apenas uma mera impressão, os eletrônicos de hoje já são fabricados com uma "validade reduzida", em outras palavras, chamamos isto de "obsolescência programada" .

Com produtos que não terão mais atualizações, ou quebrarão depois de um certo tempo, a população é forçada cada vez mais a consumir desenfreadamente. Desta forma, temos um novo problema: o acúmulo de lixo eletrônico.

A Ecoleta nasceu com o propósito de minimizar esse problema e realizar o descarte adequado aos eletrônicos. A API realiza o cadastro de pessoas da cidade de Belo Horizonte (MG) que desejam realizar o descarte e não sabem por onde começar.


📌Sumário

✅Objetivos

  • Cadastro de usuários interessados;
  • Autenticação de usuário e senha;
  • Simplificar o processo de cadastro de materiais eletrônicos elegíveis à coleta;

✅Aprendizados

O projeto final consiste em uma API fundamentada no CRUD, que são: CREATE (CRIAR), READ(LER-CONSULTA), UPDATE(ATUALIZAR) e DELETE(REMOÇÃO).

✅Arquitetura

    Arquitetura MVC
    |
    \--📂  API-ECOLETA
        |   README.md  
        |   .env
        |   .gitignore
        |   package-lock.json
        |   package.json
        |   **server.js**
        \--📂 node_modules
        \--📂 assets
        \--📂src
            |
            |   **app.js**
            |
            📂---controllers
            |       user.js
            |
            📂---database
            |   **config.js
            |    
            📂---helpers
            |       auth.js
            |                      
            📂---models
            |       User.js
            |
            📂---routes
            |       user.js
            |__

✅Instalação

  • Para realizar download do projeto, siga as instruções abaixo:

👩‍👧‍👦Pré-requisitos

Você precisa ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e o database NoSQL Mongodb E claro o bom e velho editor de código como VSCode

👩‍👧‍👦Rodando o Back End

Server Local

# Com o git
# Clone este repositório
$ git clone https://github.com/rnep280/api-ecoleta.git

# Acesse a pasta do projeto no terminal/cmd
$ cd api-ecoleta

# Instale as dependências
$ npm install
$ npm instal mongoose

# Execute o servidor
$ npm start

# O servidor inciará na porta:5200 - acesse <http://localhost:5200/api/users/>

Para acessar via Heroku, acesse o link da API

  • Utilize o Postman ou Insomnia para para chamar e testar os endpoints da API localmente ou via Heroku

🛠Tecnologias

Para a consturição do projeto, as seguintes tecnologiasforam utilizadas:

👩‍👧‍👦Features

Funcionalidades da aplicação

  • POST - Cadastros de usuários (nome, e-mail, senha, pergunta e resposta secreta).
  • POST - Login na conta
  • PUT - Alteração de senha / e-mail.
  • GET - Lista de usuários cadastrados.
  • DELETE - Deleção do cadastro.

👩‍👧‍👦Rotas