quirkey / sammy
- Source
- Commits
- Network (27)
- Issues (4)
- Downloads (7)
- Wiki (1)
- Graphs
-
Branch:
master
| name | age | message | |
|---|---|---|---|
| |
.gitignore | Thu Sep 03 20:51:56 -0700 2009 | |
| |
.gitmodules | Sat Sep 26 14:56:34 -0700 2009 | |
| |
HISTORY | Mon Jan 11 19:06:43 -0800 2010 | |
| |
LICENSE | Mon May 11 07:56:20 -0700 2009 | |
| |
README.md | Fri Dec 11 21:27:56 -0800 2009 | |
| |
Rakefile | Mon Jan 11 19:06:43 -0800 2010 | |
| |
examples/ | Sun Dec 27 10:21:25 -0800 2009 | |
| |
lib/ | Mon Jan 11 19:06:43 -0800 2010 | |
| |
site - 2064d74 | Sun Feb 07 17:39:47 -0800 2010 | |
| |
test/ | Mon Jan 11 18:37:21 -0800 2010 | |
| |
vendor/ | Sun Feb 07 17:39:47 -0800 2010 |
Sammy
Description
Sammy is a tiny javascript framework built on top of jQuery inspired by Ruby's Sinatra.
Installation
Download sammy.js and install it in your public javascripts directory. Include it in your document AFTER jquery.
Usage
Like Sinatra, a Sammy application revolves around 'routes'. Routes in Sammy are a little different, though. Not only can you define 'get' and 'post' routes, but you can also bind routes to custom events triggered by your application.
You set up a Sammy Application by passing a Function to the $.sammy (which is a shortcut for the Sammy.Application constructor).
$.sammy(function() {
this.get('#/', function() {
$('#main').text('Welcome!');
});
});
Inside the 'app' function() this is the Application. This is where you can configure the application and add routes.
Above, we defined a get() route. When the browser is pointed to #/ the function passed to that route will be run. Inside the route function, this is a Sammy.EventContext. EventContext has a bunch of special methods and properties including a params hash, the ability to redirect, render partials, and more.
Once you've defined an application the only thing left to do is run it. The best-practice behavior is to encapulate run() in a document.ready block:
var app = $.sammy(...)
$(function() {
app.run();
});
This will guarantee that the DOM is loaded before we try to apply functionality to it.
Dependencies
Sammy requires jQuery >= 1.3.2 Get it from: http://jquery.com
More!
Learn!
Keep informed!
Authors
Sammy.js was created and is maintained by Aaron Quint with additional features and fixes contributed by these talented individuals:
- Frank Prößdorf / endor
- Alexander Lang / langalex
- Scott McMillin / scottymac
- ZhangJinzhu / jinzhu
- Jesse Hallett / hallettj
- Jonathan Vaught / gravelpup
- Jason Davies / jasondavies
- Russell Jones / CodeOfficer
- Geoff Longman
License
Sammy is covered by the MIT License. See LICENSE for more information.
Sammy includes code originally created by John Resig (Class implementation) and Greg Borenstien (srender).
