24 lines
728 B
Markdown
24 lines
728 B
Markdown
## How to run
|
|
|
|
- Clone repo
|
|
- Copy the `config/config.example.yml` to `config/config.yml`
|
|
- Fill every option
|
|
- Compile using `shards build --release`
|
|
- Run `./bin/ivr-api-crystal`
|
|
|
|
### TODO
|
|
|
|
- ~~Use Redis to cache replies and add a new key to report for how much time the JSON is going to be stored in cache~~ Done.
|
|
- ~~Add other endpoints from api.ivr.fi~~ Almost done.
|
|
- ~~Capture more than 1 param: `?login=fijxu,fijxu`~~ Done.
|
|
|
|
### NOT SO IMPORTANT TODO
|
|
|
|
- ~~STOP USING KEMAL FOR SIMPLE THINGS~~ Nevermind, kemal is pretty useful and it should stay
|
|
- ~~`programAgreement { type }` in the Next commit~~ Done.
|
|
- Guide on how to get the tokens to get it working
|
|
- Kick API
|
|
|
|
### Suggestions
|
|
|
|
~~3:45 RyanPotat: add team~~ Done.
|