Sdelka is anki-like SRS engine, which implements another variation of SM2 algorithm. It's written entirely in typescript and is web-compatible with IDB-based implementation of storage.
Right now sdelka-engine is ready to use, but it's APIs stability is not yet guaranteed as it's at its early stages of development. APIs here are going to be as stable as I need to get them working with sdelka.
For reason described above I am not going to publish this package on NPM yet. Instead local npm registry should suffice.
Just after installing dependencies type npm run test
and that's it.
Once you have cloned this project you can npm run docs
in order to use typedoc
to generate docs for this project.
For examples take a look at unit tests, which are the best source of docs for this project so far.
This project is AGPL version 3 licensed, just like anki is. I didn't read or look at Anki code while writing this library. Instead I've recreated algorithm using my experience using Anki and some SM2 algorithm descriptions like this one on wikipedia
TODO(teawithsand): should I attribute their's copyright? AFAIK implementing somebody's ideas from the scratch isn't.
That being said I am fine with AGPLv3 license, so it's going to stay.
Wow, that's a lot of writing for a project that may end up in trash three days later.