A Rails engine that helps you put together a super-flexible admin dashboard.
Ruby HTML CSS JavaScript Shell
Latest commit 077f6d3 Dec 14, 2015 @croaky croaky Use Kaminari syntax in controller's comment hint
Wrap the method chain onto multiple lines because it's likely
the developer will want to add some `order` details or other scopes
to the chain.
Permalink
Failed to load latest commit information.
app Search Bar Display Logic (#730) Jan 17, 2017
bin Remove references to staging/production. Jan 20, 2017
config Fix typo on pt-BR translation for polymorphic (#704) Jan 17, 2017
docs Fix typo. Jan 27, 2017
gemfiles Switch administate-field-image to release. Jan 20, 2017
lib Use Kaminari syntax in controller's comment hint Feb 11, 2017
spec Redefine base resource path Feb 3, 2017
.gitignore Rearrange git repo so bundler can install from git Nov 5, 2015
.hound.yml Update rubocop configuration file to run locally Feb 14, 2016
.rspec Remove the fuubar gem Apr 19, 2016
.rubocop.yml Update rubocop configuration file to run locally Feb 14, 2016
.sample.env New suspenders app Feb 20, 2015
.scss-lint.yml Configure SCSS-Lint to allow the `font-variant-numeric` property Jan 20, 2016
Appraisals Fix the specs with the Rails 5 branch and the clear search button (#671) Oct 19, 2016
CHANGELOG.md Fix typo on pt-BR translation for polymorphic (#704) Jan 17, 2017
CONTRIBUTING.md Recommend running `rake` through `bundler` Jan 20, 2017
Gemfile Switch administate-field-image to release. Jan 20, 2017
Gemfile.lock bundle update capybara Jan 20, 2017
LICENSE.md Updated copyright notices to 2016 [ci skip] Jan 10, 2016
Procfile Improve heroku deploy workflow Nov 6, 2015
README.md Update references from old docs URL Jan 12, 2017
Rakefile Improve heroku deploy workflow Nov 6, 2015
administrate.gemspec Update references from old docs URL Jan 12, 2017
circle.yml Update bundler to 1.13.7 in Circle. Jan 20, 2017
config.ru Improve heroku deploy workflow Nov 6, 2015

README.md

Administrate

Circle CI Gem Version Code Climate

A framework for creating flexible, powerful admin dashboards in Rails. Try the demo.

Warning:

Administrate is still pre-1.0, and there may be occasional breaking changes to the API. Check the release notes for important updates.

administrate

What Is Administrate?

Administrate is a library for Rails apps that automatically generates admin dashboards. Administrate's admin dashboards give non-technical users clean interfaces that allow them to create, edit, search, and delete records for any model in the application.

Administrate solves the same problem as Rails Admin and ActiveAdmin, but aims to provide a better user experience for site admins, and to be easier for developers to customize.

To accomplish these goals, Administrate follows a few guiding principles:

  • No DSLs (domain-specific languages)
  • Support the simplest use cases, and let the user override defaults with standard tools such as plain Rails controllers and views.
  • Break up the library into core components and plugins, so each component stays small and easy to maintain.

Getting Started

Add Administrate to your Gemfile:

# Gemfile
gem "administrate", "~> 0.3.0"

Re-bundle, then run the installer:

$ rails generate administrate:install

Restart your server, and visit http://localhost:3000/admin to see your new dashboard in action.

To customize the appearance, behavior, and contents of the dashboard, see the guides at https://administrate-prototype.herokuapp.com.

Repository Structure

This repository contains both the source code for Administrate, and a demo Rails app that uses Administrate. The demo app is hosted publicly on Heroku.

  • The gem's source code lives in the app and lib subdirectories.
  • The demo app is nested within spec/example_app.

Rails configuration files have been changed to recognize the app in the new location, so running the server or deploying to Heroku works normally.

With this structure, developing a typical feature looks like:

  • Add tests in spec/
  • Implement a feature in administrate/
  • Exercise the feature using the demo rails app (spec/example_app/app/)

Contributing Guidelines

Use the following guides for getting things done, programming well, and programming in style.