Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/railsadminteam/rails_admin

RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data
https://github.com/railsadminteam/rails_admin

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/railsadminteam/rails_admin
Owner: railsadminteam
License: mit
Created: 2010-08-01T17:01:00.000Z (over 14 years ago)
Default Branch: master
Last Pushed: 2024-03-02T10:18:08.000Z (9 months ago)
Last Synced: 2024-04-14T05:12:26.863Z (7 months ago)
Language: Ruby
Homepage:
Size: 19.8 MB
Stars: 7,851
Watchers: 140
Forks: 2,251
Open Issues: 197
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # RailsAdmin

[![Gem Version](https://img.shields.io/gem/v/rails_admin.svg)][gem]

[![Build Status](https://github.com/railsadminteam/rails_admin/actions/workflows/test.yml/badge.svg)][ghactions]

[![Coverage Status](https://img.shields.io/coveralls/railsadminteam/rails_admin.svg)][coveralls]

[![Code Climate](https://codeclimate.com/github/railsadminteam/rails_admin.svg)][codeclimate]

[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rails_admin&package-manager=bundler&version-scheme=semver)][semver]

[gem]: https://rubygems.org/gems/rails_admin

[ghactions]: https://github.com/railsadminteam/rails_admin/actions/workflows/test.yml

[coveralls]: https://coveralls.io/r/railsadminteam/rails_admin

[codeclimate]: https://codeclimate.com/github/railsadminteam/rails_admin

[semver]: https://dependabot.com/compatibility-score.html?dependency-name=rails_admin&package-manager=bundler&version-scheme=semver

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

## Getting started

- Check out [the docs][docs].

- Try the [live demo][demo]. ([Source code][dummy_app])

[demo]: https://rails-admin.fly.dev/admin/

[dummy_app]: https://github.com/railsadminteam/rails_admin/tree/master/spec/dummy_app

[docs]: https://github.com/railsadminteam/rails_admin/wiki

## Features

- CRUD any data with ease

- Custom actions

- Automatic form validation

- Search and filtering

- Export data to CSV/JSON/XML

- Authentication (via [Devise](https://github.com/plataformatec/devise) or other)

- Authorization (via [CanCanCan](https://github.com/CanCanCommunity/cancancan) or [Pundit](https://github.com/elabs/pundit))

- User action history (via [PaperTrail](https://github.com/airblade/paper_trail))

- 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](http://localhost:3000/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](https://github.com/railsadminteam/rails_admin/wiki/Base-configuration)

To begin with, you may be interested in setting up [Devise](https://github.com/railsadminteam/rails_admin/wiki/Devise), [CanCanCan](https://github.com/railsadminteam/rails_admin/wiki/Cancancan) or [Papertrail](https://github.com/railsadminteam/rails_admin/wiki/Papertrail)!

### Per model

```ruby

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](https://github.com/railsadminteam/rails_admin/wiki/Models), [Groups](https://github.com/railsadminteam/rails_admin/wiki/Groups), [Fields](https://github.com/railsadminteam/rails_admin/wiki/Fields)

## Support

If you have a question, please check this README, the wiki, and the [list of

known issues][troubleshoot].

[troubleshoot]: https://github.com/railsadminteam/rails_admin/wiki/Troubleshoot

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

list][list].

[list]: http://groups.google.com/group/rails_admin

If you think you found a bug in RailsAdmin, you can [submit an issue](https://github.com/railsadminteam/rails_admin/issues/new).

## Supported Ruby Versions

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

- Ruby 2.6

- Ruby 2.7

- Ruby 3.0

- Ruby 3.1

- Ruby 3.2

- [JRuby][]

[jruby]: http://jruby.org/