Code Monkey home page Code Monkey logo

desafio-backend-lemon's Introduction

MIT License Node

API para avaliação de elegibilidade de cliente 🍋

API Rest desenvolvida para o desafio técnico da Lemon Energy
O desafio propôs uma aplicação Node para checar a elegibilidade de empresas para fazer parte da Lemon como cliente através dos dados contidos na conta de luz. Caso a empresa não seja elegível, precisamos explicitar os motivos para tal. Caso ela seja elegível, precisamos calcular também a projeção da quantidade de CO₂ que ela deixaria de emitir caso usasse energia limpa.

📌 Índice

🛠️ Ferramentas

  • ⚙️ Server: Node, Express

  • 🧪 Test: Mocha, Chai

Desenvolvimento

Aplicação foi desenvolvida com Node.js com o framework Express pensando nos princípios REST baseado na arquitetura MSC (model-service-controller) para validação de dados foi utilizado a biblioteca Joi e para garantir qualidade foram desenvolvidos testes utilizando Mocha e Chai.

Referência da API

Checa elegibilidade

  POST /elegibilidade
Parâmetro Tipo Descrição
numeroDoDocumento string Required. Número do documento do solicitante sendo CPF ou CNPJ.
tipoDeConexao string Required. Tipo de conexão sendo elas: monofasico, bifasico ou trifasico.
classeDeConsumo string Required. Classe de consumo sendo elas: comercial, residencial, industrial, poderPublico ou rural.
modalidadeTarifaria string Required. Modalidade Tarifaria sendo elas: branca, azul, verde ou convencional.
historicoDeConsumo array Required. Histórico de consumo do último ano. Deve conter no minímo os últimos 3 meses de consumo.

Exemplo de Entrada

{
  "numeroDoDocumento": "11284470000140",
  "tipoDeConexao": "bifasico",
  "classeDeConsumo": "comercial",
  "modalidadeTarifaria": "convencional",
  "historicoDeConsumo": [
    3878, // mes atual
    9760, // mes anterior
    5976, // 2 meses atras
    2797, // 3 meses atras
    2481, // 4 meses atras
    5731, // 5 meses atras
    7538, // 6 meses atras
    4392, // 7 meses atras
    7859, // 8 meses atras
    4160, // 9 meses atras
    6941, // 10 meses atras
    4597  // 11 meses atras
  ]
}

Exemplos de saída

Caso elegível 👍

{
   "elegivel": true,
   "economiaAnualDeCO2": 5553.24,
}

Caso não elegível 👎

{
  "elegivel": false,
  "razoesInelegibilidade": [
   "Classe de consumo não aceita",
   "Modalidade tarifária não aceita",
   "Consumo muito baixo para tipo de conexão"
  ]
}

Rodando Localmente

⚠️ Necessário ter node 16 e npm instalados na sua máquina!

Clone este repositório e entre na pasta do projeto

  git clone [email protected]:ribeirofrv/desafio-backend-lemon.git
  cd desafio-backend-lemon

Instale as dependências

  npm install

Inicie o servidor

  npm start

✳️ Por padrão o servidor usa a porta 3001 e pode ser alterada criando o arquivo .env

Rodando Testes

Para rodar os tests, certifique-se de estar dentro na pasta do projeto e com o servidor iniciado e então cole o seguinte comando em outra aba do terminal

  npm test

Futuras Melhorias

  • Deploy no Railway
  • Densenvolver o front-end com um formulário para captação de clientes
  • Fazer integração com um Banco de Dados para salvar clientes elegiveis

Autora

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.