Netzke Basepack Build Status Code Climate

RDocs

A pack of pre-built Netzke components that can be used as building blocks for your webapps.

Included components

Basepack includes the following components:

Besides, Basepack implements persistence of region sizes and collapsed states of an arbitrary component that uses border layout (see ItemPersistence).

For more pre-built components refer to Netzke Community-pack.

Requirements

Installation

In your Gemfile:

gem 'netzke-basepack'

For the "edge" stuff, tell bundler to get the gem straight from GitHub:

gem 'netzke-basepack', :git => "git://github.com/netzke/netzke-basepack.git"

Usage

Embed a basepack component into a view as any other Netzke component, e.g.:

<%= netzke :books, :class_name => 'Netzke::Basepack::Grid', :model => 'Book' %>

For more examples, see http://netzke-demo.herokuapp.com (source code), and look into test/basepack_test_app.

Running tests

The bundled test/basepack_test_app application used for automated testing can be easily run as a stand-alone Rails app. It's a good source of concise, focused examples. After starting the application, access any of the test components (located in app/components) by using the following url:

http://localhost:3000/components/{name of the component's class}

For example http://localhost:3000/components/BookGrid

Also, you can see the list of test components on the index page (along with links to the source code):

http://localhost:3000/

Before being able run the test app and the tests themselves, you must link your Ext JS library to test/basepack_test_app/public, e.g. (from the gems's root):

$ ln -s ~/code/sencha/ext-4.1.1 test/basepack_test_app/public/extjs

For cucumber tests (from test/basepack_test_app):

$ cucumber features

Using ORM other than ActiveRecord

Using ActiveRecord as its default ORM, Basepack is designed to be extendable with data adapters for other ORMs. If you're thinking about implementing an adapter, AbstractAdapter and ActiveRecordAdapter classes can be used as a reference.

There's some work being done in the direction of implementing DataMapper and Sequel adapters, but at this moment the code is broken.

Icons support

Netzke Basepack can make use of FamFamFam Silk icon set (http://www.famfamfam.com/archive/silk-icons-thats-your-lot/). To enable this, download the icons and put the "icons" folder into your app's public/images folder. Then restart your application.

Useful links


Copyright (c) 2008-2012 nomadcoder, released under the MIT license (see LICENSE).

Note that Ext JS is licensed differently, and you may need to purchase a commercial license in order to use it in your projects!