Coder Social home page Coder Social logo

hakki-api's Introduction

Contribuindo com o projeto

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.js

4. 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.

hakki-api's People

Contributors

juliocros avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.