Este é o README para o Projeto Solar Energy, um sistema de gerenciamento de energia solar que consiste em um frontend e um backend desenvolvidos usando Node.js, Express.js, Sequelize, JWT, Jest, Swagger, e Postgres. Este projeto permite que os usuários monitorem e controlem a produção de energia solar em suas instalações.
O projeto é dividido em duas partes principais:
- Frontend: Esta parte do projeto é responsável pela interface do usuário e permite que os usuários visualizem dados relacionados à energia solar, como produção e consumo. O frontend foi desenvolvido utilizando tecnologias modernas de front-end, como React, Bootstrap , .
- Backend: O backend é responsável por gerenciar os dados relacionados à energia solar, autenticação de usuários, e fornecer uma API para o frontend. Foi construído usando Node.js e Express.js, com um banco de dados Postgres para armazenar os dados. O Sequelize é utilizado como ORM (Object-Relational Mapping) para facilitar a interação com o banco de dados. A autenticação é realizada utilizando JWT (JSON Web Tokens) para garantir a segurança das informações.
Para executar o projeto em sua máquina local, siga as instruções abaixo:
- Clone o repositório do projeto
git clone <URL_DO_REPOSITORIO_BACKEND>- Navegue até o diretório do projeto
cd backend- Instale as dependências do projeto
npm install- Crie um arquivo .env e adicione as variáveis de ambiente necessárias como as credenciais do banco de dados e a chave secreta JWT. Você pode usar o arquivo .env.example como referência.
touch .env- Execute as migrations para criar as tabelas do banco de dados
npx sequelize-cli db:migrate- Execute o projeto
npm start ou npm run dev- O servidor estará rodando em http://localhost:3000
- Clone o repositório do projeto
git clone <URL_DO_REPOSITORIO_FRONTEND>- Navegue até o diretório do projeto
cd frontend- Instale as dependências do projeto
npm install- Execute o projeto
npm start- O servidor estará rodando em http://localhost:3001
Para executar os testes do projeto, siga as instruções abaixo:
- Navegue até o diretório do projeto
cd backend- Execute os testes
npm test- Navegue até o diretório do projeto
cd frontend- Execute os testes
npm testA documentação da API pode ser encontrada em http://localhost:3000/api-docs
Contribuições são bem-vindas! Se você deseja contribuir com melhorias para este projeto, siga os passos abaixo:
- Faça um fork deste repositório.
- Crie uma branch para a sua feature: git checkout -b minha-nova-feature.
- Faça as alterações desejadas e faça commits: git commit -m 'Adicionei uma nova feature'.
- Faça o push para a sua branch: git push origin minha-nova-feature.
- Abra um Pull Request para revisão.