Projeto fullstack realizado em Node.js com NestJS, banco de dados não relacional MongoDB e React com Typescript. Projeto construido com o intuito de finalizar o desafio proposto pela SHARENERGY, onde foi desafiado fazer um dashboard Full-Stack feito em React + Node.
Vale pontuar que o NODE deve estar instalado na máquina
O gerenciador de arquivos usado foi o yarn mais pode ser usado o npm
Realizar o clone do repositório e executar os seguintes comandos:
Para inicializar o Backend:
cd Back-End yarn install
OBS: Caso queira inicializar com docker basta criar as váriaveis de ambiente abaixo e rodar no terminal 'docker compose up'criar um arquivo .env com os paramêtros de banco de dados e URL do MONGO.
APP_PORT=
// Exemplo: APP_PORT=3000 (Caso não seja preenchido a porta como padrão estará como 3000)
MONGO_URL= mongodb+srv://<user>:<password>@cluster0.<yznzesm>.mongodb.net/<database>?retryWrites=true&w=majority
// Exemplo: mongodb+srv://admin:admin@cluster0.yznzesm.mongodb.net/sharenergy?retryWrites=true&w=majority
JWT_SECRET_KEY=
DATABASE_NAME=
Abrir o servidor
yarn start:dev
OU
yarn startAo inicializar o back-end automaticamente é criado um usuário ADMIN com os seguintes dados
username/email = desafiosharenergy
password = sh@r3n3rgyCom o servidor do backend funcionando, deve-se abrir um novo terminal na raiz do projeto e executar os seguintes comandos, para inicializar o Front-End:
O gerenciador de arquivos para o front foi utilizado o YARN.
cd Front-End yarn installPara inicializar o Frontend:
yarn install
Aplicacão estará rodando em http://localhost:3000/Para o back-end foi utilizado testes unitários, ainda não esta com cobertura de 100%, porem todas as regras de negócios, casos e controller estão cobertos
(Total de 60% da aplicacão)
**EM DESENVOLVIMENTO**
Toda a API foi documentada no swagger-ui, basta acessar o endpoint: /api
