README
¶
polycloze
A self-hosted language learning website.
Features
- Cloze deletion tests
- Auto-tuning spaced repetition algorithm
- Adaptive word scheduler
- Word scheduler estimates the student's vocabulary so it can skip words that are too easy.
- Automated course builder
Usage
# Install everything needed to build front-end.
make init
# Run server.
make run
# Open in browser.
xdg-open http://localhost:3000
Licenses
Copyright (C) 2022 Levi Gruspe
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
The scripts in ./scripts and ./database/migrations are also available under the terms of the MIT license.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
auth-related handlers.
|
auth-related handlers. |
|
User management.
|
User management. |
|
cmd
|
|
|
For managing authentication database.
|
For managing authentication database. |
|
Historical records of user's estimated level.
|
Historical records of user's estimated level. |
|
Defines the Review struct for storing rows from the Review table.
|
Defines the Review struct for storing rows from the Review table. |
|
For sending messages to session users.
|
For sending messages to session users. |
|
Testing utils.
|
Testing utils. |
|
For computing Wilson score intervals
|
For computing Wilson score intervals |
|
Returns words that the user hasn't learned.
|
Returns words that the user hasn't learned. |