1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# RailsAdmin
[][gem]
[][travis]
[][gemnasium]
[][codeclimate]
[][coveralls]
[][inch]
[gem]: https://rubygems.org/gems/rails_admin
[travis]: http://travis-ci.org/sferik/rails_admin
[gemnasium]: https://gemnasium.com/sferik/rails_admin
[codeclimate]: https://codeclimate.com/github/sferik/rails_admin
[coveralls]: https://coveralls.io/r/sferik/rails_admin
[inch]: http://inch-ci.org/github/sferik/rails_admin
RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.
## 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. Bundle the gem
2. Run `rails g rails_admin:install`
3. Provide a namespace for the routes when asked
4. Start a server `rails s` and administer your data at [/admin](http://localhost:3000/admin). (if you chose default namespace: /admin)
## Configuration
### Global
In `config/initializers/rails_admin`:
[Details](https://github.com/sferik/rails_admin/wiki/Base-configuration)
To begin with, you may be interested in setting up [Devise](https://github.com/sferik/rails_admin/wiki/Devise), [CanCanCan](https://github.com/sferik/rails_admin/wiki/Cancancan) or [Papertrail](https://github.com/sferik/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/sferik/rails_admin/wiki/Models), [Groups](https://github.com/sferik/rails_admin/wiki/Groups), [Fields](https://github.com/sferik/rails_admin/wiki/Fields)
## Documentation
https://github.com/sferik/rails_admin/wiki
## Demo
Take RailsAdmin for a [test drive][demo] with sample data. ([Source code.][dummy_app])
[demo]: http://rails-admin-tb.herokuapp.com/
[dummy_app]: https://github.com/bbenezech/dummy_app
## Support
If you have a question, please check this README, the wiki, and the [list of
known issues][troubleshoot].
[troubleshoot]: https://github.com/sferik/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/sferik/rails_admin/issues/new).
## Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby implementations:
* Ruby 1.9.3
* Ruby 2.0.0
* Ruby 2.1
* Ruby 2.2
* [Rubinius][]
* [JRuby][]
[rubinius]: http://rubini.us/
[jruby]: http://jruby.org/
|
