yunweiguya / active_admin

The administration framework for Ruby on Rails applications.

Active Admin¶ ↑

Active Admin is a Ruby on Rails framework for creating elegant backends for website administration.

<img src=“https://secure.travis-ci.org/gregbell/active_admin.png?branch=master” /> <img src=“https://codeclimate.com/github/gregbell/active_admin.png” /> <img src=“https://gemnasium.com/gregbell/active_admin.png” /> <img src=“https://coveralls.io/repos/gregbell/active_admin/badge.png?branch=master” />

Documentation & Support¶ ↑

• Documentation & Guides: activeadmin.info/documentation.html

• Wiki: github.com/gregbell/active_admin/wiki

• RDoc: rubydoc.info/gems/activeadmin/frames

• Live demo: demo.activeadmin.info/admin

• Website: www.activeadmin.info

• Need Support? Ask the Mailing list: groups.google.com/group/activeadmin

Goals¶ ↑

1. Allow developers to quickly create gorgeous administration interfaces (Not Just CRUD)

2. Build a DSL for developers and an interface for businesses.

3. Ensure that developers can easily customize every nook and cranny of the interface.

4. Build common interfaces as shareable gems so that the entire community benefits.

Getting Started¶ ↑

Active Admin is a Ruby Gem.

gem 'activeadmin'

More accurately, it’s a Rails Engine that can be injected into your existing Ruby on Rails application.

$> rails generate active_admin:install

The generator adds these core files, among others:

app/admin/dashboard.rb
app/assets/javascripts/active_admin.js
app/assets/stylesheets/active_admin.css.scss
config/initializers/active_admin.rb

Migrate your database and start the server:

$> rake db:migrate
$> rails server

Visit localhost:3000/admin and log in as the default user:

• User: [email protected]

• Password: password

Voila! You’re on your brand new Active Admin dashboard.

To register an existing model with Active Admin:

$> rails generate active_admin:resource MyModel

This creates a file at app/admin/my_model.rb to set up the UI; refresh your browser to see it.

Upgrading¶ ↑

When upgrading to a new version, it’s a good idea to check the CHANGELOG.

To update the JS & CSS assets:

$> rails generate active_admin:assets

You should also sync these files with their counterparts in the AA source code:

• app/admin/dashboard.rb ~>

• config/initializers/active_admin.rb ~>

Tools Being Used¶ ↑

We try not to reinvent the wheel, so Active Admin is built using many other open source projects:

Inherited Resources

Simplifies controllers with default actions that can be customized through inheritance

Formtastic

A Rails form builder plugin with semantically rich and accessible markup

Devise

Powerful, extensible user authentication

Kaminari

Clean & powerful pagination for your models

Iconic Icons

An excellent SVG icon set designed by P.J. Onori