https://github.com/foxbunny/ribcage

Give your Backbone app some Ribcage with Models, Views and Validation.
https://github.com/foxbunny/ribcage

Last synced: 28 days ago
JSON representation

Give your Backbone app some Ribcage with Models, Views and Validation.

• Host: GitHub
• URL: https://github.com/foxbunny/ribcage
• Owner: foxbunny
• License: mit
• Created: 2013-08-28T11:28:16.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-12-01T23:25:49.000Z (about 11 years ago)
• Last Synced: 2023-03-10T22:13:41.408Z (almost 2 years ago)
• Language: CoffeeScript
• Size: 1.37 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.mkd
  • Changelog: CHANGES.mkd
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ribcage

Ribcage for your Backbone

Ribcage is a set of mixins and libraries to make developing 

[Backbone](http://backbonejs.org/) applications easier and more strucutred.

It's also a set of opinions on how you should develop a web application.

## Requirements

Ribcage depends on Backbone (surprised?) and jQuery.

## Installing

Ribcage modules are in UMD format. This means that you can use them either as

AMD modules (with loaders like [RequireJS](http://requirejs.org/)), or load

them using `` tags.

When loading modules using the `<script>` tags, please __make sure `main.js` is

loaded before all other modules__. It will set up the `ribcage` global object

and other modules will simply assume that properties on that object have been

correctly set up.

When used with `<script>` tags, the modules will do basic dependency checking,

so you will get exceptions in many cases.

When using Ribcage as AMD modules, you can either require the entire Ribcage

using the `ribacge/ribcage` module, or you can require indivudal parts by

loading them as separate modules. Note that some Ribcage modules may depend on

other Ribcage modules (e.g., `TemplateView` depends on `BaseView`).

## Installing using volo

If you are using [volo](http://volojs.org/), you can safely install ribcage

using the usual `add` command:

    volo add foxbunny/ribcage

It will be installed into `lib/ribcage` directory, and `lib/ribcage.js` module

will be created as an alias for `lib/ribcage/main.js`. 

The CoffeeScript sources are located in the `src` directory, and are _not_

installed by volo. If you want to use the CoffeeScript version instead, simply

manually copy them into your project.

## Application project template

There are two application templates that provide a good base and also a simple

example of a Ribcage app. One of them is

[for CoffeeScript developers](https://github.com/foxbunny/create-ribcage-app),

and the other is 

[for JavaScript ninjas](https://github.com/foxbunny/create-ribcage-app-js).

The templates set up a Backbone application with Ribcage. You can use volo to

kickstart a project using the templates:

    volo create my_app foxbunny/create-ribcage-app # CoffeeScript

    volo create my_app foxbunny/create-ribcage-app-js # JavaScript

## Minified and concatenated version

No, there are none and there will never be. Why minify a single component when

there's a whole project to be minified?

## Documentation

Please see the [Ribcage wiki](https://github.com/foxbunny/ribcage/wiki) for 

introductory and cookbook articles.

The complete API documentation is available in markdown format in the [`doc`

directory](https://github.com/foxbunny/ribcage/tree/master/doc). The directory

layout reflects the layout of the `src` directory as each source code file

generates one matching Markdown document. You may want to start with the [main

module

documenation](https://github.com/foxbunny/ribcage/blob/master/doc/main.mkd)

which contains links to all Ribcage modules.

## Reporting bugs

Please report bugs to 

[Ribcage's GitHub issue tracker](https://github.com/foxbunny/ribcage/issues).