Files
flashy/README.md
T
Sven Luethi 0e4421bb2a modified: README.md
modified:   db.sql
	modified:   index.php
- Move user/pass to DB
- Implement umlaut normalization so ae, oe, ue, and ss may be used. This also avoids having to use mbstring php extension.
2023-12-21 22:30:42 +01:00

45 lines
1.6 KiB
Markdown

# Flashy - Yet another simple vocabulary trainer
This is a single-file php application for training writing using flash cards sorted into boxes.
The UI is optimized for mobile viewing. Added cards are automatically sorted into different boxes based on successfully typing in the correct answer or not.
The provided database contains cards for learning German for english speakers but it can be adapted to learn anything. Editing of words is also possible throug the UI adding an empty database is also an option. To change the flow of boxes, add/remove boxes or add/remove word classes, please tweak db.sql before creating the sqlite3 database.
## Why build it?
I wrote this small application to help my wife learn german but then thought of publishing it in case someone else is looking for a simple solution. I know there are plenty of language learning programs out there but i wanted something offline and with boxes the cards are sorted into the traditional way. Contributions and improvements are most welcome.
## Screenshots
![App UI](doc/app.png)
### Test
![Test Area](doc/test.png)
### Vocabulary Boxes
![Test Area](doc/boxes.png)
### Editor
![Test Area](doc/editor.png)
## Requirements
- php 7.0 or higher
- php-sqlite3 extension
## Installation
Create a database from the provided db.sql file:
```
sqlite db.db < db.sql
```
### Change the username/password
Find the USERNAME/PASSWORD rows in the config table inside the database and edit as needed.
You can also comment out the line
```
new Auth($db);
```
at the bottom of index.php to disable basic authentication completely.