README.md

Component Driven Architecture with Luca.JS

Luca is a component architecture framework based on Backbone.js, which includes many development helpers, classes, patterns, and tools needed to build scalable and clean single page applications.

It uses twitter bootstrap compatible markup and css naming conventions, making it possible to generate completely styled user interfaces with JSON alone.

Documentation Site and Examples

API Documentation

Component Examples

This is the app that runs the documentation site:

Sample App

Using the Library from CDN

Include the Javascripts:

<script type='text/javascript' src='//datapimp.github.io/luca/vendor/assets/javascripts/luca-dependencies.min.js'></script>
<script type='text/javascript' src='//datapimp.github.io/luca/vendor/assets/javascripts/luca.min.js'></script>

Include the CSS:

<link href='//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.0/css/bootstrap-combined.min.css' rel='stylesheet'>
<link href='//netdna.bootstrapcdn.com/font-awesome/3.0.2/css/font-awesome.css' rel='stylesheet'>
<link href='//datapimp.github.com/luca/vendor/assets/stylesheets/luca-ui.css' rel='stylesheet'>

Using With Rails Asset Pipeline

  # Gemfile
  gem 'luca', :git => "[email protected]:datapimp/luca.git" 

In your css manifest:

  /*
   *= require 'luca'
  */

All Javascript Dependencies:

  //= require 'luca/dependencies'
  //= require 'luca'

Your App:

  Luca.initialize('App', {
    // will look in window.AppBootstrap for an object
    // keyed on your collection's cache_keys() for automatically
    // populating collections on page load
    modelBootstrap: true,
    // will look in window.AppBaseParams for an object
    // or function used to determine the query parameters to
    // be sent on every request
    baseParams: true
  });

  JST['home'] = function() {
    // content
  };

  App.register('App.views.Home').extends('Luca.View').defines({
    template: "home",
    events: {
      "click .menu-handler" : "clickMenuHandler"
    },
    clickMenuHandler: function(e){

    }
  });

  App.register('App.Application').extends('Luca.Application').defines({
    // will use the Application classes internal controller
    // to make the home 'page' active in the viewport
    routes:{
      "" : "home"  
    }
    components:[
      name: "home"
      type: "home"
    ]
  });

  AppNamespace.onReady(function(){
    (new AppNamespace.Application).boot()
  })

Rails Generator

To generate Luca application skeleton run:
rails generate luca:application <app_name>
This will generate a controller, view, route, and the Luca application structure under assets/javascripts/<app_name>

Contributing

You will need to run 'rake release:all' to compile/minify the asset which gets released.

Thanks To

@jashkenas, @davidgtonge, @twitter, @madrobby, et al.

Contributors

@tjbladez, @grilix, @nick-desteffen