Trellis

What

Trellis is an object-oriented, event-driven, page and component-based Web
Application Framework written in Ruby. Its main goal is to bring
component-driven development to the micro-framework world.
The framework is a zero configuration framework.

It draws inspiration from:

Ruby Web Frameworks
=======

• Rails
• Camping
• Merb
• Iowa

Java Web Frameworks
=======

• Tapesty
• Wicket
• The good parts of JSF (components)
• Seam (session per conversation)

Installing

sudo gem install trellis

The basics

A Trellis application consists of the Application class; a descendant of
Trellis::Application and one or more pages; descendants of Trellis::Page. The
Application at a minimum needs to declare the starting or home page:

  module Hello
    class HelloWorld < Trellis::Application
      home :home
    end

    class Home < Trellis::Page 
      template_as_markaby do html { body { h1 "Hello World!" }} end
    end
  end

Demonstration of usage

To run the above application simply add the line:

Hello::HelloWorld.new.start

That will start the application on Mongrel running on port 3000 by default. To
run on any other port pass the port number to the start method like:

Hello::HelloWorld.new.start 8282

Forum

http://groups.google.com/group/trellis

How to submit patches

Read the 8 steps for fixing other people’s code and for section 8b: Submit patch to Google Groups, use the Google Group above.

TODO – pick SVN or Git instructions

The trunk repository is svn://rubyforge.org/var/svn/trellis/trunk for anonymous access.

OOOORRRR

You can fetch the source from either:

• rubyforge: MISSING IN ACTION

TODO – You can not created a RubyForge project, OR have not run rubyforge config
yet to refresh your local rubyforge data with this projects’ id information.

When you do this, this message will magically disappear!

Or you can hack website/index.txt and make it all go away!!

• github: http://github.com/GITHUB_USERNAME/trellis/tree/master

git clone git://github.com/GITHUB_USERNAME/trellis.git

TODO – add “github_username: username” to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.

• gitorious: git://gitorious.org/trellis/mainline.git

git clone git://gitorious.org/trellis/mainline.git

Build and test instructions

cd trellis
rake spec
rake install_gem

License

This code is free to use under the terms of the MIT license.

Contact

Comments are welcome. Send an email to Brian Sam-Bodden email via the forum

FIXME full name, 25th August 2008
Theme extended from Paul Battley