netzke-core

Create Ext JS + Rails reusable components (widgets) with minimum effort.

This is the bare bones of the Netzke framework. Use it to build your own widgets from scratch. For pre-built widgets (like panels, grids, forms, trees, applications), see the netzke-basepack (github.com/skozlov/netzke-basepack) project.

The idea behind the Netzke framework is that it allows you write reusable client/server code. Create a widget, and then embed it (or load it dynamically) into your Ext-based applications or HTML pages. For more info, see the links below.

Instalation

For the latest ("edge") stuff, install as plugin (recommended!):

    ./script/plugin install git://github.com/skozlov/netzke-core.git

Otherwise, install as gem. The gem is hosted on gemcutter. If you haven’t yet enabled gemcutter, run the following:

    sudo gem install gemcutter && gem tumble

Install the gem

    sudo gem install netzke-core

Generate the migrations for Netzke persistent storage:

    ./script/generate netzke_core

Run the migrations.

Netzke assumes that your ExtJS library is in public/extjs (which may be a symbolic link).

Usage

Here’s how to embed a Netzke widget into your Rails view.

1. In your layout, within the "head" tag, use the netzke_init helper to include all the necessary JavaScript and styles.

    <%= netzke_init %>
   

2. In config/routes.rb declare the Netzke routes:

    map.netzke
   

3. In your view use the netzke helper wherever you want to insert a widget.

    <%= netzke :grid_panel, :data_class_name => "User", :columns => [:id, :name, :created_at] %>
   

(here we use the GridPanel widget from the netzke-basepack project)

More info

Introduction to Netzke framework and wiki: github.com/skozlov/netzke

Twitter: twitter.com/skozlov

Tutorials: blog.writelesscode.com

Live-demo: netzke-demo.writelesscode.com

The netzke-basepack project (pre-built full-featured widgets): github.com/skozlov/netzke-basepack

Copyright © 2009 Sergei Kozlov, released under the MIT license