= Active Admin

Active Admin is a framework for creating administration style interfaces. It
abstracts common business application patterns to make it simple for developers
to implement beautiful and elegant interfaces with very little effort.

{<img src="https://secure.travis-ci.org/gregbell/active_admin.png?branch=master" />}[http://travis-ci.org/gregbell/active_admin]
{<img src="https://codeclimate.com/github/gregbell/active_admin.png" />}[https://codeclimate.com/github/gregbell/active_admin]
{<img src="https://gemnasium.com/gregbell/active_admin.png" />}[https://gemnasium.com/gregbell/active_admin]
{<img src="https://coveralls.io/repos/gregbell/active_admin/badge.png?branch=master" />}[https://coveralls.io/r/gregbell/active_admin?branch=master]

== Documentation & Support

* Documentation & Guides: http://activeadmin.info/documentation.html
* Wiki: https://github.com/gregbell/active_admin/wiki
* RDoc: http://rubydoc.info/gems/activeadmin/frames
* Live demo: http://demo.activeadmin.info/admin
* Website: http://www.activeadmin.info
* <b>Need Support?</b> Ask the Mailing list: http://groups.google.com/group/activeadmin

== Goals

1. Allow developers to quickly create gorgeous administration interfaces
   <b>(Not Just CRUD)</b>
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.

== Bugs Reports & Contributing

* Bug Reports: https://github.com/gregbell/active_admin/issues
* Want to Contribute? Read the Guide: https://github.com/gregbell/active_admin/blob/master/CONTRIBUTING.md

== Feature Requests

Please don't put feature requests in Github Issues. They will be closed as soon as they
are reviewed by one of the core team members. If you would like a feature in Active Admin,
please submit a well tested pull request with the desired changes. If you're not a coder,
then the mailing list may be a good place to try to convince someone to help you out
with your cause.

If you are going to submit a pull request, please read the contributing guide:
https://github.com/gregbell/active_admin/blob/master/CONTRIBUTING.md


== Getting Started

Active Admin is released as a Ruby Gem. The gem is to be installed within a Ruby
on Rails 3 application. To install, simply add the following to your Gemfile:

  gem 'activeadmin'

After updating your bundle, run the installer

  $> rails generate active_admin:install

The installer creates an initializer used for configuring defaults used by Active Admin as well
as a new folder at <tt>app/admin</tt> to put all your admin configurations.

Migrate your db and start the server:

  $> rake db:migrate
  $> rails server

Visit http://localhost:3000/admin and log in using:

* *User*: admin@example.com
* *Password*: password

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

To register your first model, run:

  $> rails generate active_admin:resource [MyModelName]

This creates a file at <tt>app/admin/my_model_names.rb</tt> for configuring the resource.
Refresh your web browser to see the interface.

== Upgrading

When upgrading to a new version of ActiveAdmin you may need to run
  $> rails generate active_admin:assets

If you get:
  uninitialized constant Admin::DashboardController
when trying to view the dashboard (at +/admin+), ensure +app/admin/dashboards.rb+ looks like the current {default}[https://raw.github.com/gregbell/active_admin/master/lib/generators/active_admin/install/templates/dashboard.rb].


== Next Steps

The best place to get documentation is at http://activeadmin.info/documentation.html.

To view a sample Active Admin application, checkout http://demo.activeadmin.info

If you have any questions, please email the mailing list at http://groups.google.com/group/activeadmin


== Tools Being Used

We believe strongly in not writing code unless we have to, so Active Admin is built using many
other open source projects:

InheritedResources::
  Inherited Resources speeds up development by making your controllers inherit all restful
  actions so you just have to focus on what is important.
Formtastic::
  A DSL for semantically building amazing forms.
Devise::
  User authentication is done using Devise
Kaminari::
  Pagination for rails apps
Iconic Icons::
  Excellent SVG icon set designed by P.J. Onori: http://somerandomdude.com/projects/iconic


== Copyright

Copyright (c) 2011 Greg Bell, VersaPay Corporation. See LICENSE for details.