Conventions for server-side
backbone.js views/controllers. Provides a set of
overrides to allow the same Views and Controllers to be used both client-side
+--------+ | Models | +-----------> +--------+ <------------+ | | Views | | | +--------------+ | | | Controllers | | | +--------------+ | +---------+ +---------+ | Browser | | Server | +---------+ +---------+
Getting started with Bones
- Install node v0.4.* and npm 1.*
- Create package.json file
- Add bones as a bundleDependency/clone repo for development
See https://github.com/developmentseed/skeleton for an example app that layout.
Bones expect you to organize your application in a certain way, and treats a few directories in special ways.
/commands- extra command line commands
/controllers- Backbone controllers
/models- Backbone models
/routers- server only routes
/views- Backbone views
With the exception of
/templates/ these directories will be populated with
.bones files. Bones automatically adds the normal boilerplate stuff you would otherwise need to add to files suffixed with
.bones. This has the additional benefit of not loading extra detection code to determine if the code is running on the server or client. Bones will simply add the right code.
Files in each of these directories are expected to provide a single model|view|controller|template|etc... The file should be named as the class is name, capitalization is important! A
BlogPost model should be defined in a
Creating an application
Bones won't load new files automatically, you need to tell Bones to do that. Create a server by adding a file to
/servers, and then register your models|views|controllers|templates|etc... The example application has an example server in
Your application will need a entry point, an
index.js. The example application again provides a good starting point here.
Note, the second line of the file will need to be changed so that bones isn't included as using a relative path. Your application's
index.js should say:
var plugin = module.exports = require('bones').plugin(__dirname);
- adding child modules (bones-document)
- creating new components (.extend) vs. augmenting existing (.augment)
- adding template engines (see bones/core/index.js)
- server side vs. client side template compilation
Defining models & controllers
Bones provdes default routes for loading models and collections. To take advantage of these endpoints your models and collections should implement a
url method that returns a string of the form;
api/:model/:id. The result of the
url method is treated as the canonical resource identifier for that object.