Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.4 KB

README.md

File metadata and controls

82 lines (53 loc) · 2.4 KB

Super

Unit tests status Gem

Super is an admin framework for Ruby on Rails applications. It helps you make admin pages quickly, and it provides a powerful interface for admins to use.

Check out the demo / Read the docs

Features

Ease of use and setup

  • Configurable display pages
    • Advanced filtering and sorting
    • Supports showing computed values that aren't backed by database fields
  • Configurable form pages
    • Supports nested attributes using accepts_nested_attributes_for
    • Supports having different forms for new and edit pages
  • Controllers that can automatically configure itself for any ActiveRecord model
  • Compatible with Sprockets, Webpacker, jsbundling, and cssbundling
  • Responsive and mobile-friendly web pages

Ease of customization

  • Plenty of escape hatches for those very customized pages
  • Builds on top of standard Rails controllers and ERB views
  • No DSL. Configure your admin pages by setting attributes and returning objects

Ease of long-term maintainability

Each gem in your Gemfile requires some maintenance around keeping dependencies up to date. Super works hard to keep its maintenance as simple as possible.

Note: Super is under active development and will likely have a few more breaking changes before 1.0.

  • Only depends on code that comes with Rails or Ruby. There are no other third-party dependencies
  • Includes pre-built frontend assets. Super doesn't depend on Sass, PostCSS, Babel, etc
  • Supports Rails 5.0+, 6.0+, 7.0+
  • Supports Ruby 2.3+, 3.0+

See the demo and its source for an example of some of its features. See the docs for a walkthrough.

Quick start

Install Super by running:

bundle add super
bin/rails g super:install

You can create admin pages by running this for all the models you want:

bin/rails g super:resource ModelName

Contributing

See CONTRIBUTING

License

The gem is available under the terms of the GNU LGPLv3.