ivr-api-crystal/README.md

25 lines
726 B
Markdown
Raw Normal View History

2024-06-22 02:35:49 -04:00
## 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`
2024-05-19 03:50:02 -04:00
### TODO
2024-06-22 02:35:49 -04:00
- ~~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.
2024-05-19 03:50:02 -04:00
### NOT SO IMPORTANT TODO
2024-06-22 02:35:49 -04:00
- ~~STOP USING KEMAL FOR SIMPLE THINGS~~ Nevermind, kemal is pretty useful and it should stay
- `programAgreement { type }` in the Next commit.
- Guide on how to get the tokens to get it working
- Kick API
2024-05-19 03:50:02 -04:00
### Suggestions
2024-06-22 02:35:49 -04:00
~~3:45 RyanPotat: add team~~ Next commit.