How jenswittmann/curlyframework works
Project type and purpose
• CurlyFramework is a front-end UI framework/library (CSS + JS) meant to be installed via npm or git, and then integrated into static sites or CMS templates (e.g., MODX, Kirby). It provides SCSS modules, JS utilities, and a build pipeline to produce a ready-to-ship CSS/JS bundle, plus a styleguide/demo site.
File structure
• Top-level files & folders:
• dev/ – source SCSS partials (_*.scss) and raw JS, plus a JS bundle template
• demo/ – sample JSON data for demonstration
• styleguide/ – compiled CSS, JS, and HTML pages illustrating framework usage
• index.html – entry point demo
• package.json, build/config files (.editorconfig, .prettierrc, CodeKit)
• No server-side code; this is a build-and-publish pipeline producing static assets.
README for additional insights
• Confirms it’s a “personal framework for more accessibility and sustainability.”
• Installation via npm and a hosted documentation/demo URL.
Elements
• From source folders (dev/css, dev/js) into build steps
• From build steps into outputs (styleguide/, npm package)
• From npm package into Consumer Integration
• e.g., blue for source code, green for build tools, orange for distribution artefacts, purple for consumer/demo
Detailed capture of essential architectural elements
• Folder boundaries (dev vs. styleguide vs. demo)
• Configuration files (.editorconfig, .prettierrc, package.json) feeding into the build toolchain