A CLI version of Never Forget, a spaced repetition learning app.
It makes heavy use of Inquirer and Commander to interact with the user and make the experience pleasant.
For the Spaced Repetition functionality I worked off of and adapted / modified the memory-scheduler algorithm. At the moment, the adapted version uses hour-based intervals rather than day-based. You can change this by playing with the values in src/prompts/study.js.
So far, all of the main functionality has been implemented. You can:
- Create a deck
- Create a card
- Browse decks
- Browse cards
- Edit a deck
- Edit a card
- Delete a deck
- Delete a card
- Import cards
- Export cards
- Study cards
To build, cd to project root and run:
$ npm install && npm run build
This should install dependencies and then output a transpiled version of app.js to src/dist. From there you can run the app directly like so node dist/app.js [command], as shown in the proceeding section.
First, you can run the app with the help option for details on how to use its api:
$ node dist/app.js -h
Usage: index [options] [command]
Never Forget CLI
Options:
-v, --version output the version number
-h, --help output usage information
Commands:
configure|c configure a new database
createdeck|cd create a new deck
deldecks|dd delete one or more decks
editdeck|ed edit deck details (name / description)
addcard|a add a card
delcards|dc delete one or more cards
editcard|ec edit card details (prompt, target, etc.)
browse|b browse cards
import|i import one or more cards into a deck
export|ex export a deck of cards
study|s study cards scheduled for review
If you want to go beyond this however, you will need access to a Mongo database, as that's what the app uses for data storage. You can either opt for a local database or something like Atlas.
Once you have the database connection string, you can either run node dist/app.js c to have the app configure the database itself or save the string to ./config/dbUrl. After that, you should be ready to roll!
The source of this app may be used under the WTFPL - or, if you take issue with that, consider it to be under the CC0.
Feedback and contributions are welcome. Feel free to create issues, fork, submit pull requests, etc. However, if you make any changes to the application logic, make sure to run the full test suite before opening a PR.
To run tests, simply execute the following in the project root:
$ npm test
PR's that do not include output from the above command will be rejected automatically!
Finally, if you want to contribute in a different way, you can always buy me a coffee ^_^
