How anais0210/checklist-rncp6-cda works
Project Type and Purpose
• This is a static, front-end checklist application (no backend services). It delivers a two-page UI (index.html and questions.html) where users track and validate RNCP6 CDA checkpoints. JavaScript modules manage UI state (navigation, filtering, progress, notes, exports), and configuration lives in a config.json. Linting (HTMLHint, Stylelint) and an accessibility test script (test-a11y.js) enforce quality via GitHub Actions.
File-Structure Analysis
• Top level:
• .github/workflows/quality.yaml → CI pipeline for linting
• index.html, questions.html → entry pages
• styles.css → global CSS
• config.json → checklist data
• test-a11y.js → custom a11y checks
• package.json + lock → NPM scripts, lint deps
• js/ directory: nine modules handling specific UI features:
• app.js – application bootstrap & module wiring
• navigation.js – page routing / menu
• filters.js – checklist filtering
• search-manager.js – free-text search
• notes-manager.js – user notes storage
• progress.js – completion tracking
• export.js – exporting data
• reset-manager.js – clearing state
• project-name-manager.js – naming projects
Key Insights from README
• Purpose: checklist tracking and validation.
• Tech stack: vanilla HTML/CSS/JS, HTMLHint, Stylelint.
• CI: GitHub Actions runs linting on every push/PR.
Main System Components
a. Client Browser
• Entry: index.html & questions.html
• Loads styles.css, JS modules, config.json
b. Configuration Service (static file server)
• Hosts config.json, HTML, CSS, JS
c. JS Module Layer (in-browser)
• App Bootstrap (app.js) coordinates:
• Navigation Manager
• Filters Manager
• Search Manager
• Notes Manager (persists to localStorage)
• Progress Manager
• Export Manager
• Reset Manager
• Project Name Manager
d. Data Store
• Browser LocalStorage (notes, progress, project name)
• In-memory state for filters/search
e. CI/CD Pipeline
• GitHub Actions (quality.yaml)
• Runs HTMLHint on HTML
• Runs Stylelint on CSS
• Runs test-a11y.js for accessibility
Relationships and Data Flows
• Browser requests HTML pages → pages include CSS & JS.
• JS modules fetch config.json → build checklist UI.
• User interactions → JS managers update in-memory state & LocalStorage → UI updates.
• Export manager packages state & config → prompts user download.
• Code commits → GitHub Actions → run lint & a11y tests → pass/fail feedback.
Architectural Patterns & Design Principles
• Modular JS: one module per concern (SRP).
• Static-site architecture: no server-side logic.
• CI as code: linters executed on every push via GH Actions.
Final Advice
• Every JS module as an individual component.
• Detail the CI workflow separately from run-time architecture.