Este repositório contém a implementação da API do sistema MEC-Energia.
O sistema MEC-Energia tem por objetivo auxiliar as instituições de ensino superior (IES) a gerenciar e avaliar a adequação de contratos de conta de energia elétrica a partir do registro das faturas mensais de energia, gerando relatórios de recomendações de ajustes nos contratos visando economia de recursos.
A documentação online do sistema está disponível em Documentação
Para acessar o banco, é recomendado que você tenha Docker Compose instalado em sua máquina.
Copie o arquivo .env.dev para .env:
cp .env.dev .env
Então levante os containeres da API e do banco de dados com:
docker-compose up -dSe tudo deu certo, a API do Django REST deve estar acessível em http://localhost:8080.
Além disso, a API também tem seus endpoints documentados no Swagger em http://localhost:8080/api/swagger/schema/.
Para ter acesso completo dos dados nos dois links, você precisa criar um usuário. Leia sobre como fazer isso em seed.
- Leia o Código de Conduta do projeto;
- Veja as Políticas do projeto.
Para saber mais sobre como configurar o seu ambiente de desenvolvimento e outras coisas, acesse os seguintes links:
- Comece aqui: ambiente de desenvolvimento
- Seed/popular
- Testes
- Depuração