Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/tdude/lus-2024/archive/refs/heads/main.zipUpdates itself. It ships its own updater, so new versions appear under Dashboard → Updates.
Lus, a reading assessment plugin refactoring project, soon including AI assessments of recorded text passages
Project Overview
A WordPress plugin for recording and evaluating reading comprehension, being refactored for improved maintainability and extensibility.
Architecture
- Why "lus"? In Swdish it's LäsUtvecklingsStöd. It's open source, you name it what you want!
Frontend Structure
- Standardized HTML using data attributes (data-lus-)
- Modular JavaScript architecture
- Consistent UI components throughout the admin and public part
- Event-driven interactions
Backend Structure
- Standardized AJAX handlers
- Content type trait system
- Unified response format
- Centralized error handling
Implementation Plan
Phase 1: Infrastructure (Status: 🔄 In Progress)
- [ ] Core JavaScript Architecture
- [ ] Event system
- [ ] UI components
- [ ] Data handlers
- [ ] PHP Base Classes
- [ ] Content handler trait
- [ ] Response formatter
- [ ] Base AJAX handlers
Phase 2: Content Types (Status: 📊 Planning)
Each content type follows this implementation sequence:
1. Database Schema
2. PHP Handlers
3. JavaScript Handlers
4. UI Components
5. Testing
6. Documentation
Passages