cli-learning-cards

Small CLI application for repeating terms with a card system.

Setup

git clone git@github.com:ger-benjamin/cli-learning-cards.git

npm install

npm run build

Add a source.json file with this structure in the data folder:

{
  "items": [
    {
      "id": "My beautiful sentence",
      "card": {
        "front": {
          "main": "My beautiful sentence"
        },
        "back": {
          "main": "Ma belle phrase"
        }
      }
    }
  ]
}

Or a more complete one, see the possibilities in the src/source-json.ts file.

Run

Running the game and saving it will modify the source file placed in the data folder!

npm start

On cards, you can use the special key words "_hint", "_skip" or "_exit".

Next steps

• Add a "help" scene.
• Add a possibility to select selection strategy.
• Add a possibility to edit answers.
• Add a possibility to start up with a configuration (args)
• Release and run it without compiling it.
• Move to deno ?
• Add import source script.

Release

export VERSION={put your version here}
git checkout main
git pull origin main
vim package.json # change the version
git commit -a -m "Release $VERSION"
git tag $VERSION
git push origin $VERSION main