Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 2.78 KB

README.md

File metadata and controls

93 lines (62 loc) · 2.78 KB

Derby

The Derby MVC framework makes it easy to write realtime, collaborative applications that run in both Node.js and browsers.

See https://derbyjs.com/

Examples

Directory

https://directory.derbyjs.com/

Example of a typical application with a few routes. This is the best example to use as a starting point for writing an application in DerbyJS.

Hello

https://hello.derbyjs.com/

Minimal "Hello, world" example.

Chat

https://chat.derbyjs.com/lobby

A simple chat demo. Note that as you edit your name, it updates in realtime. Name changes also show up in the page title and other rooms. Check out the source in the examples directory to see how these bindings are created automatically.

Todos

https://todos.derbyjs.com/derby

The requisite MVC demo, but collaborative and realtime! Todo items are contenteditable fields with support for bold and italics.

Sink

https://sink.derbyjs.com/

A kitchen-sink style example with a bunch of random features. Largely used for testing.

Installing

To run these examples on your own machine, first install Node.js. You'll also need MongoDB installed and running.

Then, clone this repo from GitHub.

You can run each of the examples from their own directories:

$ cd ~/derby-examples/directory
$ node server.js

The examples written in CoffeeScript are meant to be run via the coffee command:

$ npm install -g coffeescript
$ cd ~/derby-examples/sink
$ coffee server.coffee

If you would like to run all of the examples at once you can do

cd ~/derby-examples
node server.js

If you run into an EMFILE error on Mac or Linux you can up your file limit with ulimit -n 2560

MIT License

Copyright (c) 2011 by Nate Smith

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.