Study Card Tool

A handy tool for vocabulay study and learning through repetition.

License

GNU Affero General Public License version 3.0: https://www.gnu.org/licenses/agpl-3.0.en.html

Development requirements

node 14 or later: https://nodejs.org/en/
yarn 1.22 or later: https://yarnpkg.com/

Running a develpoment environment

Clone repository: git clone https://git.studycardtool.org/studycardtool/app.git studycardtool
Enter local repository folder: cd studycardtool
Install dependencies: yarn
Run development mode: yarn start

Deploying your own

It should be possible to host studycardtool in any static file server.

Run yarn build to generate a build folder
Deploy contents of build folder onto a static server

If you need further advice you could can check the "start a website" tutorial at https://landchad.net/

Contributing

Register onto this gitea service either through a local account or a federated account. Bug reports, comments, design ideas and code contributions are welcome.

Much-needed improvements from most critical to least critical

Better PWA lifecycle management
- Don't attempt to register right away
- Inform user of updates and easy way to reload the updated tool
Clear usage instructions
Better error indication
Data model update management
- Cleanly handle old data without destroying important user data
- Upgrade what can be upgraded, add "old" category labels to cards that may be missing newer information
Better parsing of Wiktionary data
- Handle declension tables
- Handle more word languages
- Handle different description languages (can't be done with current method because element IDs change between languages)
Configuration of acceptable card sections
Data backups as downloadable files, ability to add card packs from a file

Other ideas

Other ideas and use cases for the tool may be welcome. If the idea departs a lot from this toll, it may be wiser to discuss with me first before sinking too much time into it if you are hoping to merge it into the mainstream, or forking the project for the different usage cenario.

Two small tools to doing two different tasks well is better than one big tool doing two tasks poorly.

2.2 KiB Raw Blame History