How smashing/smashing works
Smashing is a Sinatra-based framework for creating and serving real-time dashboards. The main workflow is: a user creates a project with the CLI, starts its server, dashboard pages render widgets, scheduled jobs publish events, and connected browsers receive those events over server-sent events. The repository also includes generators and Gist-based widget installation. The map reflects documented and excerpted behavior; generated-project wiring and several frontend asset relationships were not sampled, so those links are omitted where unverified.
Main entry points: cli.rb Smashing CLI · app.rb Sinatra app · layout.erb Dashboard layout · batman.jquery.js jQuery adapter
Components 21
Project creation
- Smashing CLI
lib/dashing/cli.rb - Project template
templates/project - Resource templates
templates - Gist downloader
lib/dashing/downloader.rb
Dashboard server
- Sinatra app
lib/dashing/app.rb - Dashboard views
templates/project/dashboards - Widget views
templates/project/widgets
Live updates
- Scheduled jobs
templates/project/jobs - Event dispatch
lib/dashing/app.rb - Event history
lib/dashing/app.rb
Browser interface
- Dashboard layout
templates/project/dashboards/layout.erb - Widget components
templates/project/widgets - Project JavaScript
templates/project/assets/javascripts/application.coffee - Batman framework
javascripts/batman.js - jQuery
javascripts/jquery.js - jQuery adapter
javascripts/batman.jquery.js - ES5 shim
javascripts/es5-shim.js - Dashboard assets
templates/project/assets
Other components
- Dashboard builder
- GitHub Gists
- Dashboard viewer
Connections 19
- Dashboard builder → Smashing CLI: creates or starts
README.md - Smashing CLI → Project template: generates project
lib/dashing/cli.rb - Smashing CLI → Resource templates: generates resources
lib/dashing/cli.rb - Smashing CLI → Gist downloader: requests Gist
lib/dashing/cli.rb - Gist downloader → GitHub Gists: fetches Gist
lib/dashing/downloader.rb - Smashing CLI → Sinatra app: starts server
lib/dashing/cli.rb - Sinatra app → Dashboard views: renders dashboard
lib/dashing/app.rb - Sinatra app → Widget views: serves widget view
lib/dashing/app.rb - Scheduled jobs → Event dispatch: publishes events
templates/project/jobs/sample.rb - Sinatra app → Event dispatch: routes event posts
lib/dashing/app.rb - Event dispatch → Event history: stores events
lib/dashing/app.rb - Event dispatch → Dashboard viewer: streams events
lib/dashing/app.rb - Dashboard viewer → Dashboard layout: views dashboard
README.md - Dashboard layout → Widget components: presents widgets
- Project JavaScript → Batman framework: uses framework
- jQuery adapter → Batman framework: extends DOM
javascripts/batman.jquery.js - jQuery adapter → jQuery: uses AJAX and DOM
javascripts/batman.jquery.js - Dashboard layout → Dashboard assets: uses assets
- ES5 shim → Dashboard viewer: supports compatibility