<commit_before>= 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" />}[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]
{<img src="http://badgr.co/gittip/activeadmin.png" />}[https://www.gittip.com/activeadmin/]

== 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.

== Getting Started

Active Admin is a Ruby Gem.

  gem 'activeadmin'

More accurately, it's a {Rails Engine}[http://guides.rubyonrails.org/engines.html]
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 http://localhost:3000/admin and log in as the default user:

* *User*: <EMAIL>
* *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 <tt>app/admin/my_model.rb</tt> 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}[https://github.com/gregbell/active_admin/blob/master/CHANGELOG.md].

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 {~>}[https://github.com/gregbell/active_admin/blob/master/lib/generators/active_admin/install/templates/dashboard.rb]
* config/initializers/active_admin.rb {~>}[https://github.com/gregbell/active_admin/blob/master/lib/generators/active_admin/install/templates/active_admin.rb.erb]

== Tools Being Used

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

{Inherited Resources}[https://github.com/josevalim/inherited_resources]::
  Simplifies controllers with default actions that can be customized through inheritance
{Formtastic}[https://github.com/justinfrench/formtastic]::<commit_msg>shorten gem description in README<commit_after>= 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" />}[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]
{<img src="http://badgr.co/gittip/activeadmin.png" />}[https://www.gittip.com/activeadmin/]

== 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.

== Getting Started

Active Admin is a Ruby Gem.

  gem 'activeadmin'

More accurately, it's a {Rails Engine}[http://guides.rubyonrails.org/engines.html]
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 http://localhost:3000/admin and log in as the default user:

* *User*: <EMAIL>
* *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 <tt>app/admin/my_model.rb</tt> 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}[https://github.com/gregbell/active_admin/blob/master/CHANGELOG.md].

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 {~>}[https://github.com/gregbell/active_admin/blob/master/lib/generators/active_admin/install/templates/dashboard.rb]
* config/initializers/active_admin.rb {~>}[https://github.com/gregbell/active_admin/blob/master/lib/generators/active_admin/install/templates/active_admin.rb.erb]

== Tools Being Used

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

{Inherited Resources}[https://github.com/josevalim/inherited_resources]::
  Simplifies controllers with pre-built RESTful controller actions
{Formtastic}[https://github.com/justinfrench/formtastic]::
{'fraction_non_alphanumeric': 0.1172876304023845, 'fraction_numerical': 0.002384500745156483, 'mean_word_length': 4.991964285714285, 'pattern_counts': {'":': 0, '<': 27, '<?xml version=': 0, '>': 41, 'https://': 28, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6361215', 'n_tokens_mistral': 2090, 'n_tokens_neox': 2039, 'n_words': 571}