Strut - An ImpressJS GUI / Authoring Tool
Switch branches/tags
Nothing to show
Pull request Compare This branch is 1019 commits behind tantaman:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client
server
.gitignore
LICENSE.txt
README.md

README.md

Strut

GUI / Authoring Tool for ImpressJS

This project intends to create an extensible, maintainable, and clean editor for authoring ImpressJS presentations. I hope this project can also serve as an example of a browser based rich client as the project matures.

Don't know what ImpressJS is? Check out the ImpressJS demo presentation: http://bartaz.github.com/impress.js/#/bored And here is a video of the very first version of Strut: http://www.youtube.com/watch?v=zA5s8wwme44

Strut live preview: http://tantaman.github.com/Strut/client/web/index.html

Prior Art

Whats the difference between Strut and Impressionist? From a developer's perspective, everything.

In Strut there is an object for each major component. The Slides, SlidePreviews, TransitionEditor, SlideEditor, etc. all have their own objects so its easy to track down and make changes to a component. Strut uses RequireJS to keep source files small and focused. BackboneJS is used for Strut's data model and serialization as well as for binding events in the view layers.

In addition to having organized code, the markup for Strut is also split up by component and placed in HandlebarsJS template files.

Preview

A github hosted preview is available at: http://tantaman.github.com/Strut/client/web/index.html

The preview currently points to the development version of Strut.

Building

Most of Strut is written in Coffeescript and uses precompiled templates for HTML rendering.

To compile the CoffeeScript

  1. Install CoffeeScript (sudo npm install -g coffee-script)
  2. cd to the Strut/client directory
  3. run rake compileCoffee[w] (omit [w] to not watch for changes)

To compile the templates

  1. Install Handlebars (sudo npm install -g handlebars)
  2. cd to the Strut/client directory
  3. run rake compileTpls

Running

Strut can run enteirely from your local filesystem.
Just point your browser to file:///path/to/strut/client/web/index.html to view Strut.

Contributing

Here is the basic layout of the source:

  • Presentation Model: src/model/presentation
  • Editor UI Layer: src/ui/editor
  • Model -> ImpressJS Rendering: src/ui/impress_renderer

templates for UI components are contained in src/ui/COMPONENT_NAME/res/templates in order to package related markup and backing UI (not model) code into modules.

Acknowledgements