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” /> <img src=“https://codeclimate.com/badge.png” /> <img src=“https://gemnasium.com/gregbell/active_admin.png” />
-
Documentation & Guides: activeadmin.info/documentation.html
-
Live demo: demo.activeadmin.info/admin
-
Website: www.activeadmin.info
-
Need Support? Ask the Mailing list: groups.google.com/group/activeadmin
-
Allow developers to quickly create gorgeous administration interfaces (Not Just CRUD)
-
Build a DSL for developers and an interface for businesses.
-
Ensure that developers can easily customize every nook and cranny of the interface.
-
Build common interfaces as shareable gems so that the entire community benefits.
-
Bug Reports: github.com/gregbell/active_admin/issues
-
Want to Contribute? Read the Guide: github.com/gregbell/active_admin/blob/master/CONTRIBUTING.md
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: github.com/gregbell/active_admin/blob/master/CONTRIBUTING.md
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 app/admin to put all your admin configurations.
Migrate your db and start the server:
$> rake db:migrate $> rails server
Visit 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 app/admin/my_model_names.rb for configuring the resource. Refresh your web browser to see the interface.
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.
The best place to get documentation is at activeadmin.info/documentation.html.
To view a sample Active Admin application, checkout demo.activeadmin.info
If you have any questions, please email the mailing list at groups.google.com/group/activeadmin
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: somerandomdude.com/projects/iconic
Copyright © 2011 Greg Bell, VersaPay Corporation. See LICENSE for details.