1. Primeiro, clone a API no diretório de sua preferência:
git clone https://github.com/julioCROS/Hakki-API/2. Crie um arquivo chamado .env.local, abra o arquivo e insira o seguinte texto: DB_CONNECTION = X. No lugar de X, insira a URL de conexão do banco de dados (neste caso, dessa API, utilizamos o MongoDB).
3. Após configurar a URL de conexão do banco de dados, você pode então executar o projeto a partir do seguinte comando:
node bin/server.js4. Com isso, você conseguirá ver e entender melhor, o recebimento e envio de requisições a partir da página localhost:3000 utilizando alguma plataforma de API (como Postman, Insomnia, etc).
Você agora é capaz de editar o projeto a sua vontade, desde elaborar novas requisições, modificar modelos existentes, entre muitas outras coisas. Caso queira subir para este repositório algumas novas funcionalidades criadas por você, abra um Pull Request.
Caso queira contribuir com o projeto, é interessante você passar pelos outros dois projetos ligado ao Sistema Hakki:
- Hakki Web - Interface Web para se comunicar com esta API (Hakki API), cadastrando novos professores e avaliações, além de ser possivel acessar as avaliações enviadas para cada um dos professores cadastrados
- Hakki Chrome Extension - Extensão criada para injetar um script na página de matricula do SIGAA alimentado pela API para mostrar as notas referente aos professores.