baeeq / strut

Strut - An ImpressJS GUI / Authoring Tool

Strut

Note: Strut is being largely re-written to support 3rd party extensions and mobile devices. You can check on the progress of the re-write on the rewrite branch.

Strut is getting a facelift too:

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 (Firefox, Chrome and Safari only): http://tantaman.github.com/Strut/dist/index.html

Preview

A github hosted preview is available at: http://tantaman.github.com/Strut/dist/index.html (Firefox, Chrome and Safari only)

The preview currently points to the development version of Strut.

Mailing List

[email protected]

Pre-Built versions of Strut

You can get pre-built versions of strut here: http://code.google.com/p/strut/downloads/list

Running

The pre-built versions of Strut can be run entirely from your local filesystem.
Just point your browser to file:///path/to/Strut/dist/index.html to view Strut.

Development/Building

To build your own version of Strut you'll need Grunt v4.0 or later.

Note: these instructions currently only work for the rewrite branch of Strut as that is where developing is currently occurring.

1. Install the latest Grunt: npm install -g grunt-cli
2. Clone Strut: git clone git://github.com/tantaman/Strut.git
3. cd Strut
4. Install Strut's development dependencies: npm install
5. Run Strut: grunt server

Yeoman will automatically compile your coffeescript and templates and reload your browser whenever there is a code change.

To make a production build of Strut run grunt build. The resulting build will be location in Strut/dist.

Contributing

Strut uses a Maven directory layout so code and resource will be found in src/main

In Strut there is an object for each major component. The Slides, SlidePreviews, TransitionEditor, SlideEditor, etc. all have their own objects so it's 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.

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

• ImpressJS (of course) https://github.com/bartaz/impress.js/
• BackboneJS http://documentcloud.github.com/backbone/
• CoffeeScript http://coffeescript.org/
• RequireJS http://requirejs.org/
• JQuery http://jquery.com/
• Rake http://rubyforge.org/projects/rake/
• HandlebarsJS http://handlebarsjs.com/
• DustJS http://akdubya.github.com/dustjs/
• Class class http://ejohn.org/blog/simple-javascript-inheritance/
• Impressionist https://github.com/hsivaramx/Impressionist