RailsAdmin

RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.

It started as a port of MerbAdmin to Rails 3 and was implemented as a Ruby Summer of Code project by Bogdan Gaza with mentors Erik Michaels-Ober, Yehuda Katz, Luke van der Hoeven, and Rein Henrichs.

Announcements

• Actions

Custom actions are finally there. Default should stay put. To customize them, please have a look at:

Wiki: actions
Documented source code: Base Action class

• Translations

Translations have been totally revamped (for custom actions)

Translation keys for actions now look like:

en:
  admin:
    actions:
      <action_name>:
        title: "..."
        menu: "..."
        breadcrumb: "..."

Other keys may have changed too.

Old outdated translations have been removed, you must now fetch them from the wiki.

See Wiki for more informations.

Thanks a lot to all the translators sharing their work, sorry for the added worked (it was really needed).

• History

If you wish to continue using the old history feature, please add this to your initializer:

config.audit_with :history, User

Alternatively, PaperTrail is now officially compatible. Install it, add has_paper_trail to the models you wish to track, and add this instead to your initializer:

config.audit_with :paper_trail, User

Change User with the class you use with Devise.

By default, there won't be any history shown.

Features

• Display database tables
• Create new data
• Easily update data
• Safely delete data
• Custom actions
• Automatic form validation
• Search and filtering
• Export data to CSV/JSON/XML
• Authentication (via Devise)
• Authorization (via Cancan)
• User action history (internally or via PaperTrail)
• Supported ORMs
  • ActiveRecord

Demo

Take RailsAdmin for a test drive with sample data. (Source code.)

Installation

In your Gemfile, add the following dependencies:

gem 'fastercsv' # Only required on Ruby 1.8 and below
gem 'rails_admin', :git => 'git://github.com/sferik/rails_admin.git'

Run:

$ bundle install

And then run:

$ rails g rails_admin:install

This generator will install RailsAdmin and Devise if you don't already have it installed. Devise is strongly recommended to protect your data from anonymous users. It will modify your config/routes.rb, adding:

mount RailsAdmin::Engine => '/admin', :as => 'rails_admin' # Feel free to change '/admin' to any namespace you need.

It will add an intializer that will help you getting started. (head for config/initializers/rails_admin.rb)

Optionaly, you may want to set up Cancan, PaperTrail, CKeditor

More on that in the Wiki

Usage

Start the server:

$ rails server

You should now be able to administer your site at http://localhost:3000/admin.

Configuration

All configuration documentation has moved to the wiki: https://github.com/sferik/rails_admin/wiki

Support

Please see list of know issues first.

If you have a question, you can ask the official RailsAdmin mailing list or ping sferik on IRC in #railsadmin on irc.freenode.net.

Check this README and the wiki first.

If you think you found a bug in RailsAdmin, you can submit an issue No feature requests or questions please (the mailing list is active).

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

• by using alpha, beta, and prerelease versions
• by reporting bugs
• by suggesting new features
• by translating to a new language
• by writing or editing documentation
• by writing specifications
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by resolving issues
• by reviewing patches
• financially

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix. NOTE - there's a small test app located in the spec/dummy_app directory that you can use to experiment with rails_admin.
4. Add documentation for your feature or bug fix.
5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
6. Add specs for your feature or bug fix.
7. Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

• Ruby 1.8.7
• Ruby 1.9.2
• Ruby 1.9.3
• Rubinius
• Ruby Enterprise Edition
• JRuby

Screenshots