jdufresne / rails_admin

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RailsAdmin

Gem Version Build Status Coverage Status Code Climate SemVer

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

Getting started

Features

  • CRUD any data with ease
  • Custom actions
  • Automatic form validation
  • Search and filtering
  • Export data to CSV/JSON/XML
  • Authentication (via Devise or other)
  • Authorization (via CanCanCan or Pundit)
  • User action history (via PaperTrail)
  • Supported ORMs
    • ActiveRecord
    • Mongoid

Installation

  1. On your gemfile: gem 'rails_admin', '~> 3.0'
  2. Run bundle install
  3. Run rails g rails_admin:install
  4. Provide a namespace for the routes when asked
  5. Start a server rails s and administer your data at /admin. (if you chose default namespace: /admin)

Upgrading from 2.x

Due to introduction of Webpack/Webpacker support, some additional dependency and configuration will be needed. Running rails g rails_admin:install will suggest you some required changes, based on current setup of your app.

Configuration

Global

In config/initializers/rails_admin.rb:

Details

To begin with, you may be interested in setting up Devise, CanCanCan or Papertrail!

Per model

class Ball < ActiveRecord::Base
  validates :name, presence: true
  belongs_to :player

  rails_admin do
    configure :player do
      label 'Owner of this ball: '
    end
  end
end

Details: Models, Groups, Fields

Support

If you have a question, please check this README, the wiki, and the list of known issues.

If you still have a question, you can ask the official RailsAdmin mailing list.

If you think you found a bug in RailsAdmin, you can submit an issue.

Supported Ruby Versions

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

  • Ruby 2.6
  • Ruby 2.7
  • Ruby 3.0
  • Ruby 3.1
  • Ruby 3.2
  • JRuby

About

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

License:MIT License


Languages

Language:Ruby 85.4%Language:JavaScript 7.9%Language:HTML 5.3%Language:SCSS 1.1%Language:Dockerfile 0.3%Language:CSS 0.0%Language:Shell 0.0%Language:TypeScript 0.0%