marbles

Marblesjs

NOTE: The API is currently still in flux, stay aware of changes before updating.

Marbles is a JavaScript framework inspired by Backbone.js and React.

There is no view component, it's recomended you use React.

Usage

npm

npm install marbles

var Router = require('marbles/router');
var extend = require('marbles/utils').extend;
// ...

Sprockets

# Gemfile
gem 'marbles-js', :git => 'https://github.com/jvatic/marbles-js.git'
gem 'es6-module-mapper', :git => 'https://github.com/jvatic/es6-module-mapper.git';

require 'sprockets'
require 'es6-module-mapper' # or some other means of ES6 module support
require 'marbles-js'

::Sprockets::Environment.new do |env|
  # we're not using the directive processor, so unregister it
  env.unregister_preprocessor(
    'application/javascript', ::Sprockets::DirectiveProcessor)
  ::MarblesJS::Sprockets.setup(env)
end

Docs

cd docs
python -m SimpleHTTPServer

and open localhost:8000 in your browser.

Building

npm install
bundle
bundle exec rake compile

Some TODOs

• Finalize API / work out inconsistencies
  • Move away from callbacks and use Dispatcher events and promises instead
• Write tests (API is nearing completion and is no longer likely to drastically change).
• Write more in-depth usage examples

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request