How kevanmacgee/project-notes works
Project type and purpose
• This is a single-page, static web application (an “inline HTML/CSS/JS” tool) designed to run locally in the user’s browser.
• Its sole purpose is to provide a lightweight, per-project KanBan board + link organizer, with data persistence via browser localStorage and import/export via JSON files.
File structure
• Top-level files:
• index.html – contains all HTML markup, CSS (Bootswatch theme), and JavaScript logic in one file.
• README.md – describes usage, features, and intended local-only operation.
• No backend, no build scripts, no external services beyond a CSS theme CDN.
Key insights from README
• Data is stored in browser localStorage, keyed by the filename.
• Users can export/import the entire state as a JSON file.
• Uses Bootswatch for light/dark themes.
• Drag & drop features for both KanBan cards and links.
• Spellcheck handled by the browser.
Main components
a. Browser (runtime environment)
b. index.html application, logically split into:
• UI Layer
• KanBan Board (4 columns, draggable cards)
• Link Collection Panel (list of URLs, drag-reorder)
• Theme Toggle (Light/Dark via Bootswatch)
• Application Logic
• Drag & drop handlers
• Data model in JS
• Import/Export routines (JSON ↔ file system)
• Persistence Layer
• browser.localStorage API
c. External resources
• Bootswatch CSS CDN (theme styles)
• Browser Spellcheck subsystem
d. File system
• JSON file export/import
Relationships and interactions
• On page load: index.html → Browser parses HTML/CSS/JS → UI renders.
• User actions (e.g., drag card, add link) → JS logic updates in-memory data model → JS writes to localStorage.
• Export action → JS reads from localStorage → prompts user to download JSON file.
• Import action → user selects JSON file → JS parses it → overwrites in-memory model + localStorage → UI re-renders.
• Theme toggle → loads CSS from Bootswatch CDN → updates UI styles.
• Spellcheck → provided automatically by browser on text inputs.
Architectural patterns / design principles
• Single-page application (SPA) pattern without server side.
• Separation of concerns (logically) into UI, logic, persistence—even though in one file.
• Progressive enhancement: relies solely on browser APIs (no server).
• Data stored locally; each HTML file instance is its own isolated “project.”