Git Product home page Git Product logo

hercules's Introduction

hercules

hercules, the Roman God of Power, will provide you with the API for information related to IIT Kharagpur's academic life.

Motivation

  • No more ad-hoc scrapping code.
  • No more JSON files in projects.
  • Single source of truth for all the projects.
  • Building stuff should be a fun and creative process and shouldn't be hampered by the difficulty in the procurement of data.

Implementation

  • I've tried to use microservices as extensively as possible without trying to enfore the design pattern. Each service is responsible for a logical data entity and the corresponding table in the DB.

  • Inter service communication is currently carried over HTTP via SendToService function.

  • The common package provides the minimal scafolding which should be share across all the services. Essentially, it houses the data types, custom errors, database queries and the server interface.

Current List of Endpoints:

service-course

service-department

service-faculty

Roadmap

After laying down the basic infrastructure for the project, I plan to develop the API on a needs basis.
This would mean that new endpoints would be developed on based on the use-cases around the problem statement.
For the time being, I have a shortlist of projects which I think would benefit the most from the API provided by hercules.

October 2019: Port wimp to use hercules.
November 2019: Port mcmp to hercules.
December 2019: Port Kronos to hercules.
December 2019: Port gyft to hercules.

Contributing

I have commented a lot of possible improvements to the API as TODO in the code which can be good place to start.
At the same time, new/parallel feature requests are welcomed and I would try my best to accomodate time to discuss them through.

Apart from contributing LoC, you can help us by discussing some of the techincal problems we are currently facing:

  • Keep the DB updated: Schedule the scrapping of data from the source links and triage.
  • Testing handlers, unit testing models and functional testing services.
  • Deploy services after writing docker-compose.

hercules's People

Watchers

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