How litefallen/keyboard_trainer works
Project type and purpose
• This is a full-stack web application written in Python using Flask.
• Purpose: provide users with a browser-based typing-test trainer, with user authentication and session-based results storage.
File structure
Top-level:
• main.py and draft.py – entry points
• application/ – Flask application package
• instance/application.sqlite – SQLite database
• requirements.txt – Python dependencies
application/ sub-structure:
• blueprints.py – blueprint definitions (routes grouping)
• database.py & models.py – ORM setup for user & test results
• key_listener.py – uses the external “keyboard” library to capture keystrokes
• words.py, words_sort.py – business logic for word selection & sorting
• static/ – CSS files under static/css
• templates/ – Jinja2 HTML templates for all pages
README for additional insights
• Confirms use of Flask, flask-login for auth.
• Uses the “keyboard” Python module for keystroke capture.
• Word lists imported from an external JSON/text dictionary.
Main components and relationships
a. Frontend (Client Browser)
– HTML templates (index, login, signup, typing_test, profile, main_page)
– CSS files (main.css, styles.css)
– Minimal or no custom JavaScript (server-side key capture via keyboard module)
b. Backend (Flask Application)
– Flask app instance (main.py initializes, application/blueprints.py registers routes)
– Auth subsystem (flask-login)
– Business logic modules:
• words.py & words_sort.py (word list loading, sorting algorithms)
• key_listener.py (real-time keystroke capture & timing)
– Data access layer:
• database.py (SQLAlchemy setup)
• models.py (User, TestResult models)
– Configuration:
• .gitignore, requirements.txt, instance/ folder for secrets & SQLite file
c. Persistence
– SQLite database (instance/application.sqlite)
d. External services/libraries
– Python keyboard module for low-level key events
– External word-list repository (dwyl/english-words) pulled in as JSON/text files
– Flask-login for session management
Architectural patterns and design principles
• MVC (Model: models.py; View: Jinja2 templates; Controller: blueprint route functions)
• Modularization via Blueprints
• Separation of concerns:
• Auth logic isolated in flask-login
• Business logic in specialized modules (words.py, key_listener.py)
• Data layer in database.py/models.py
Final checklist
• Labels for technologies (Flask, SQLAlchemy, keyboard module)