Adminterface <!-- omit in toc -->

A gem that brings Bootstrap 5, advanced customizability, and other goodies into ActiveAdmin

Dependencies

• Ruby >= 2.7
• Rails >= 6.0
• ActiveAdmin ~> 2.9
• Bootstrap ~> 5.1.3
• Webpacker ~> 5.0

Quick Start

1. Add the following to your application's Gemfile: ruby gem "adminterface"
2. Then execute: bash $ bundle install
3. Install ActiveAdmin (If you haven't) bash $ rails g active_admin:install --use_webpacker
4. Install Adminterface

This command will ask for permissions to overwrite files generated by ActiveAdmin. Make sure to review the files carefully and accept them. We recommend you commit your files before running this command to ensure you are aware of the changes made.

   $ rails g adminterface:install

1. Migrate your database and start the server bash $ rails db:migrate $ rails server

Documentation

Check our website to find in-depth documentation for everything that Adminterface offers.

Contributing

See CONTRIBUTING.md.

License

Adminterface is free for personal and non-commercial use and with a yearly subscription for commercial purposes. See our Terms of Service in full text for more information.

For Commerical License

Get a license at https://adminterface.io/pricing, then create and add the license_key into the following file in your project:

# config/initializers/adminterface.rb
Adminterface.setup do |config|
  config.license_key = "**********************"

  ## Use Rails credentials:
  ## doc: https://edgeguides.rubyonrails.org/security.html#custom-credentials
  # config.license_key = Rails.application.credentials.adminterface[:license_key]

  ## Or, use environment variables:
  # config.license_key = ENV["ADMINTERFACE_LICENSE_KEY"]
end