Packages

fluminus

0.3.0
2.2.9 2.2.8 2.2.7 2.2.6 2.2.5 2.2.4 2.2.3 2.2.2 2.2.1 2.2.0 2.1.5 2.1.4 2.1.3 2.1.2 2.1.1 2.1.0 2.0.3 2.0.2 2.0.1 2.0.0 1.4.3 1.4.2 1.4.1 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.0 1.1.1 1.1.0 1.0.0 0.3.0 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.3 0.1.2 0.1.1 0.1.0 0.0.1

A library for the reverse-engineered LumiNUS API (https://luminus.nus.edu.sg)

HexDocs Report package

Current section

Files

Jump to
Documentation
License
44 Versions
6 Dependencies
Dependants
Files
Activity
fluminus README.md
Raw

README.md 

# Fluminus
[![Build Status](https://travis-ci.com/indocomsoft/fluminus.svg?branch=master)](https://travis-ci.com/indocomsoft/fluminus)
[![Coverage Status](https://coveralls.io/repos/github/indocomsoft/fluminus/badge.svg?branch=master)](https://coveralls.io/github/indocomsoft/fluminus?branch=master)
<sup><sub>F LumiNUS! IVLE ftw! Why fix what ain't broken?!</sub></sup>
If you are looking for the CLI tool, it has been refactored as a separate package: https://github.com/indocomsoft/fluminus_cli
Since IVLE will be deprecated next academic year (AY2019/2020), while LumiNUS has consistently pushed back its schedule to release an API, I have decided to reverse-engineer the API used by the Angular front-end of LumiNUS.
I try to keep to best coding practices and use as little dependencies as possible. Do let me know if you have any suggestions!
PR's are welcome.
## Installation
### As a dependency
This package can be installed by adding `fluminus` to your list of
dependencies in `mix.exs`:
```elixir
def deps do
  [
    {:fluminus, "~> 0.2.3"}
  ]
end
```
Documentation can be found at [https://hexdocs.pm/fluminus](https://hexdocs.pm/fluminus).