IgorCruzz / recrutamento-back-end

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🖥️ Backend

Coverage Status

nuvemWEB - http://nuvem-web.herokuapp.com/

GitHub



📊 Swagger Documentation

https://nuvemweb.herokuapp.com/api-docs/

-


📊 About the project

Está aplicação foi desenvolvida com ReactJS, foi projetada para listar servidores do sistema nuvemWEB mostrando todos os servidores estando online ou offline e listando os 10 servidores com mais consumo diário, sendo como requerimento para ve-los, precisa criar uma conta.



📊 Enviroment variables

REACT_APP_API_KEY => (INSIRA O BEARER TOKEN ENVIADO PELA API DE LISTAGEM DE SERVIDORES)
REACT_APP_URL => (INSIRA A URL DA API VINDA DO BACKEND DESTE PROJETO)
SENDGRID_API_KEY => (API VINDO DO SENDGRID)
HOST_EMAIL => (INSIRA O EMAIL SENDER QUE VOCÊ INSERIU NO SITE DO SENDGRID)
URL => (URL DA PARTE FRONTEND DO SISTEMA NUVEMWEB)
JWT_SECRET => (SECRET DO JWT)
JWT_EXPIRESIN => (TEMPO LIMITE PARA EXPIRAR O TOKEN JWT)

🔑 Scripts

  • yarn build => (faz o build da aplicação)
  • yarn pre:start => (roda as migrations do banco de dados, antes de iniciar em produção)
  • yarn start => (inicia a aplicação em modo de produção)
  • yarn start:dev => (inicia a aplicação em modo de desenvolvimento)
  • yarn lint => (verifica os erros com eslint)
  • yarn format => (formata o codígo no padrão certo)
  • yarn test => (executa testes de aplicação)
  • yarn test:verbose => (executa testes de aplicação mostrando os logs completos)
  • yarn test:unit => (executa testes unitários da aplicação)
  • yarn migration:run => (sobe as migrações pro banco de dados)
  • yarn test:staged => (executa testes que estão ativos no momento)
  • yarn test:cov => (executa testes mostrando a cobertura)
  • yarn test:ci => (executa testes unitários mostrando a cobertura)
  • yarn test:coveralls => (executa testes e sobe para o coveralls)
  • yarn pretest:integration => (sobe as migrações para o SQLITE antes de roda os teste de integração)
  • yarn test:integration => (roda os teste de integrações)

🔨 Features

- Solid
- Patterns: Decorator, Adapter
- Clean Architecture

🔨 Estrutura do projeto

* src

    Infra: Responsável pela implementação com frameworks externos.
    Data: Responsável pela implementação da regra de negócios.
    Domain: Responsável pela criação da regra de negócio.
    Presentation: Responsável pela apresentação da camada da regra de negócio.
    Main: Responsável pela parte principal da aplicação.

🚀 Tecnologias


🔑 Getting Started

Follow the steps below

📊 after All

Se você deseja testar esta aplicação localmente vai ser necessário criar uma conta no Sendgrid.
(O motivo é que precisará dele para receber o código de authorization e de atualização de senha,
por email.)
-  Cadastre-se por este link -> (https://signup.sendgrid.com/)
-  Crie um e-mail sender (Single Sender Verification) (https://app.sendgrid.com/settings/sender_auth)
-  Crie uma integração do tipo Web API (https://app.sendgrid.com/guide/integrate)

  # Instale as dependencias
  $ yarn

  # Rode as migrations antes de iniciar o servidor
  $ yarn migration:run

  # Inicie os serviços com yarn start
  $ yarn start:dev

  # Bem feito, projeto está iniciado!

About


Languages

Language:TypeScript 98.5%Language:JavaScript 1.3%Language:Shell 0.1%