How mhd101/online_code_editor works
Project Type and Purpose
• This is a front-end only, single-page web application (“Online Code Editor”) that runs entirely in the browser.
• It uses HTML/CSS/JavaScript (with the Tailwind CSS framework) and the CodeMirror library to provide a live, syntax-highlighted code editing environment and a preview runner.
File-Structure Analysis
• Top-Level Files
• index.html, editor.html, features.html, aboutus.html – entry points/views
• index.css, tailwind.css, script.js, toggle.js, Parser.js – styling and custom logic
• package.json, tailwind.config.js – build/dev configuration
• codemirror/ – full source of the CodeMirror library (editor engine)
• node_modules/ – npm dependencies (only used during development/build)
• No backend directories: all logic and data handling (save, run, preview) are client-side.
Key Architecture Components (to include
A. User’s Browser (Client):
– Loads index.html → bootstraps the SPA
– Manages routing or switches between static HTML pages (editor, features, about)
B. UI Layer
– Navigation / View Loader (links to editor, about, features)
– Editor View (editor.html) containing:
• Code Editor Component (CodeMirror instance loaded via codemirror/lib/codemirror.js)
• Toolbar Buttons (Save, Toggle Full-Screen, Run) wired via toggle.js and script.js
• Preview Pane (iframe or sandboxed container)
C. CodeMirror Library
– Syntax-Highlighting Engine (core + addons for auto-close tags, linting, fullscreen)
– Modes & Themes (CSS/JS under codemirror/mode and codemirror/theme)
– Configuration loaded at runtime from rollup.config.js (for build) or via script.js includes
D. Code Runner & Preview Engine
– Parser.js parses user input (if needed) or sanitizes code
– script.js integrates editor content into the Preview Pane (iframe.srcdoc)
– iframe sandbox isolates execution of user HTML/CSS/JS
E. Persistence Layer (Client-side)
– Save File functionality via browser APIs (LocalStorage or FileSaver)
– No remote server – data never leaves user’s browser
F. Build & Deployment
– Tailwind CLI or PostCSS (using tailwind.config.js & tailwind.css) for styling
– npm scripts (package.json) for development/build
– Hosted on Netlify (or similar) via git push → CI/CD
Relationships & Data Flows
1. User types code → CodeMirror instance emits “change” events
2. Editor → script.js/Parser.js → Preview Pane (iframe)
3. User clicks “Save” → script.js triggers file download or LocalStorage write
4. User toggles fullscreen → toggle.js manipulates editor DOM and CodeMirror API
5. Build time: tailwind.css + static assets → deployed to CDN
Architectural Patterns / Principles
• Single-Page Architecture (client-side navigation)
• Modular Components: Editor, Preview, Controls
• Library as a Submodule: CodeMirror is included wholesale (not an external service)
• Sandbox Isolation: using iframe to run untrusted user code
• Client-Only Persistence: no backend, adheres to privacy and simplicity