Skip to content
This repository
Newer
Older
100644 191 lines (138 sloc) 6.911 kb
f4f98ef4 »
2012-05-07 Update README
1 # RailsAdmin [![Build Status](https://secure.travis-ci.org/sferik/rails_admin.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/sferik/rails_admin.png?travis)][gemnasium] [![Click here to lend your support to: RailsAdmin and make a donation at www.pledgie.com !](https://www.pledgie.com/campaigns/15917.png)][pledgie]
63876182 »
2011-12-17 Condense build status and dependency status
2 RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.
a7640733 »
2011-11-21 Convert README to ASCII English text
3
63876182 »
2011-12-17 Condense build status and dependency status
4 [travis]: http://travis-ci.org/sferik/rails_admin
5 [gemnasium]: https://gemnasium.com/sferik/rails_admin
6 [pledgie]: http://www.pledgie.com/campaigns/15917
a7640733 »
2011-11-21 Convert README to ASCII English text
7
63876182 »
2011-12-17 Condense build status and dependency status
8 It started as a port of [MerbAdmin][merb-admin] to Rails 3 and was implemented
9 as a [Ruby Summer of Code project][rubysoc] by [Bogdan Gaza][hurrycane] with
10 mentors [Erik Michaels-Ober][sferik], [Yehuda Katz][wycats], [Luke van der
11 Hoeven][plukevdh], and [Rein Henrichs][reinh].
e5c769d6 »
2011-11-29 reordonated [ci skip]
12
63876182 »
2011-12-17 Condense build status and dependency status
13 [merb-admin]: https://github.com/sferik/merb-admin
14 [rubysoc]: http://www.rubysoc.org/projects
15 [hurrycane]: https://github.com/hurrycane
16 [sferik]: https://github.com/sferik
17 [wycats]: https://github.com/wycats
18 [plukevdh]: https://github.com/plukevdh
19 [reinh]: https://github.com/reinh
a7640733 »
2011-11-21 Convert README to ASCII English text
20
254018ed »
2012-05-01 Update README
21 ## Features
a7640733 »
2011-11-21 Convert README to ASCII English text
22
23 * Display database tables
24 * Create new data
25 * Easily update data
26 * Safely delete data
b033db1d »
2012-01-17 added custom actions [ci skip]
27 * Custom actions
a7640733 »
2011-11-21 Convert README to ASCII English text
28 * Automatic form validation
29 * Search and filtering
30 * Export data to CSV/JSON/XML
31 * Authentication (via [Devise](https://github.com/plataformatec/devise))
d5c5ccdb »
2012-01-04 added naive implementation for PaperTrail
32 * Authorization (via [Cancan](https://github.com/ryanb/cancan))
33 * User action history (internally or via [PaperTrail](https://github.com/airblade/paper_trail))
e5c769d6 »
2011-11-29 reordonated [ci skip]
34 * Supported ORMs
8206f1cb »
2011-12-01 Cleanup readme
35 * ActiveRecord
3a87bc56 »
2012-03-12 add Mongoid, remove old announcements [ci skip]
36 * Mongoid [new]
8206f1cb »
2011-12-01 Cleanup readme
37
254018ed »
2012-05-01 Update README
38 ## Demo
a7640733 »
2011-11-21 Convert README to ASCII English text
39
8206f1cb »
2011-12-01 Cleanup readme
40 Take RailsAdmin for a [test drive][demo] with sample data. ([Source code.][dummy_app])
6b8cee7e »
2011-11-29 demo [ci skip]
41
8206f1cb »
2011-12-01 Cleanup readme
42 [demo]: http://rails-admin-tb.herokuapp.com/
43 [dummy_app]: https://github.com/bbenezech/dummy_app
78a56037 »
2011-11-29 demo [ci skip]
44
254018ed »
2012-05-01 Update README
45 ## Installation
a7640733 »
2011-11-21 Convert README to ASCII English text
46 In your `Gemfile`, add the following dependencies:
47
48 gem 'fastercsv' # Only required on Ruby 1.8 and below
e12f8b4f »
2012-04-16 Prepare for initial gem release
49 gem 'rails_admin'
a7640733 »
2011-11-21 Convert README to ASCII English text
50
51 Run:
52
53 $ bundle install
54
55 And then run:
56
57 $ rails g rails_admin:install
58
59 This generator will install RailsAdmin and [Devise](https://github.com/plataformatec/devise) if you
60 don't already have it installed. [Devise](https://github.com/plataformatec/devise) is strongly
0dcd688a »
2012-05-31 Updated README to mention removing registerable module
61 recommended to protect your data from anonymous users. Note: If you do not already have [Devise](https://github.com/plataformatec/devise)
62 installed, make sure you remove the registerable module from the generated user model.
63
64
a7640733 »
2011-11-21 Convert README to ASCII English text
65 It will modify your `config/routes.rb`, adding:
66
d5c5ccdb »
2012-01-04 added naive implementation for PaperTrail
67 ```ruby
68 mount RailsAdmin::Engine => '/admin', :as => 'rails_admin' # Feel free to change '/admin' to any namespace you need.
69 ```
70
0b435308 »
2012-05-31 Update README with infinite redirect warning
71 Note: Your RailsAdmin namespace cannot match your Devise model name, or you will get an infinite redirect error.
72 The following will generate infinite redirects.
73
74 ```ruby
75 mount RailsAdmin::Engine => '/admin', :as => 'rails_admin'
76 devise_for :admins
77 ```
78
79 Consider renaming your RailsAdmin namespace:
80
81 ```ruby
786c5da4 »
2012-05-31 Switch to underscore for consistency.
82 mount RailsAdmin::Engine => '/rails_admin', :as => 'rails_admin'
0b435308 »
2012-05-31 Update README with infinite redirect warning
83 devise_for :admins
84 ```
85
86 See [#715](https://github.com/sferik/rails_admin/issues/715) for more details.
87
47de6c6d »
2012-03-10 (Docs) Update README.md with minor grammatical fixes.
88 It will also add an intializer that will help you getting started. (head for config/initializers/rails_admin.rb)
d5c5ccdb »
2012-01-04 added naive implementation for PaperTrail
89
0b435308 »
2012-05-31 Update README with infinite redirect warning
90
f07f005e »
2012-05-26 improved README
91 Finally run:
92
93 $ bundle exec rake db:migrate
94
576e3e4c »
2012-03-29 Remove REE support (EOL imminent)
95 Optionally, you may wish to set up [Cancan](https://github.com/ryanb/cancan),
2fd2175e »
2012-06-09 Document that the CodeMirror gem is required for a text field using t…
96 [PaperTrail](https://github.com/airblade/paper_trail), [CKeditor](https://github.com/galetahub/ckeditor), [CodeMirror](https://github.com/fixlr/codemirror-rails)
a7640733 »
2011-11-21 Convert README to ASCII English text
97
d5c5ccdb »
2012-01-04 added naive implementation for PaperTrail
98 More on that in the [Wiki](https://github.com/sferik/rails_admin/wiki)
a7640733 »
2011-11-21 Convert README to ASCII English text
99
254018ed »
2012-05-01 Update README
100 ## Usage
a7640733 »
2011-11-21 Convert README to ASCII English text
101 Start the server:
102
103 $ rails server
104
105 You should now be able to administer your site at
106 [http://localhost:3000/admin](http://localhost:3000/admin).
107
254018ed »
2012-05-01 Update README
108 ## Configuration
a7640733 »
2011-11-21 Convert README to ASCII English text
109
ece0bd44 »
2011-11-29 moved documentation to the wiki [ci skip]
110 All configuration documentation has moved to the wiki: https://github.com/sferik/rails_admin/wiki
a7640733 »
2011-11-21 Convert README to ASCII English text
111
254018ed »
2012-05-01 Update README
112 ## Screenshots
113 ![Dashboard view](https://github.com/sferik/rails_admin/raw/master/screenshots/dashboard.png "dashboard view")
114 ![Delete view](https://github.com/sferik/rails_admin/raw/master/screenshots/delete.png "delete view")
115 ![List view](https://github.com/sferik/rails_admin/raw/master/screenshots/list.png "list view")
116 ![Nested view](https://github.com/sferik/rails_admin/raw/master/screenshots/nested.png "nested view")
117 ![Polymophic edit view](https://github.com/sferik/rails_admin/raw/master/screenshots/polymorphic.png "polymorphic view")
118
119 ## Support
f4f98ef4 »
2012-05-07 Update README
120 If you have a question, please check this README, the wiki, and the [list of
121 known issues][troubleshoot].
8e09f7a4 »
2012-01-26 Put link to known issues wiki page in the README.
122
f4f98ef4 »
2012-05-07 Update README
123 [troubleshoot]: https://github.com/sferik/rails_admin/wiki/Troubleshoot
47de6c6d »
2012-03-10 (Docs) Update README.md with minor grammatical fixes.
124
125 If you still have a question, you can ask the [official RailsAdmin mailing
f4f98ef4 »
2012-05-07 Update README
126 list][list].
e5c769d6 »
2011-11-29 reordonated [ci skip]
127
f4f98ef4 »
2012-05-07 Update README
128 [list]: http://groups.google.com/group/rails_admin
129
130 If you think you found a bug in RailsAdmin, you can [submit an issue][issues].
e5c769d6 »
2011-11-29 reordonated [ci skip]
131
254018ed »
2012-05-01 Update README
132 ## Contributing
f4f98ef4 »
2012-05-07 Update README
133 In the spirit of [free software][free-sw], **everyone** is encouraged to help
134 improve this project.
135
136 [free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
a7640733 »
2011-11-21 Convert README to ASCII English text
137
138 Here are some ways *you* can contribute:
139
140 * by using alpha, beta, and prerelease versions
141 * by reporting bugs
142 * by suggesting new features
143 * by writing or editing documentation
144 * by writing specifications
f4f98ef4 »
2012-05-07 Update README
145 * by writing code (**no patch is too small**: fix typos, add comments, clean up
146 inconsistent whitespace)
a7640733 »
2011-11-21 Convert README to ASCII English text
147 * by refactoring code
f4f98ef4 »
2012-05-07 Update README
148 * by fixing [issues][]
a7640733 »
2011-11-21 Convert README to ASCII English text
149 * by reviewing patches
f4f98ef4 »
2012-05-07 Update README
150 * [financially][pledgie]
151
152 [issues]: https://github.com/sferik/rails_admin/issues
a7640733 »
2011-11-21 Convert README to ASCII English text
153
254018ed »
2012-05-01 Update README
154 ## Submitting an Issue
f4f98ef4 »
2012-05-07 Update README
155 We use the [GitHub issue tracker][issues] to track bugs and features. Before
156 submitting a bug report or feature request, check to make sure it hasn't
157 already been submitted. When submitting a bug report, please include a [Gist][]
158 that includes a stack trace and any details that may be necessary to reproduce
159 the bug, including your gem version, Ruby version, and operating system.
160 Ideally, a bug report should include a pull request with failing specs.
161
162 [gist]: https://gist.github.com/
254018ed »
2012-05-01 Update README
163
164 ## Submitting a Pull Request
165 1. [Fork the repository.][fork]
166 2. [Create a topic branch.][branch]
167 3. Add specs for your unimplemented feature or bug fix.
168 4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
169 5. Implement your feature or bug fix.
170 6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
171 7. Run `open coverage/index.html`. If your changes are not completely covered
172 by your tests, return to step 3.
173 8. Add, commit, and push your changes.
174 9. [Submit a pull request.][pr]
175
176 [fork]: http://help.github.com/fork-a-repo/
177 [branch]: http://learn.github.com/p/branching.html
178 [pr]: http://help.github.com/send-pull-requests/
179
180 ## Supported Ruby Versions
47de6c6d »
2012-03-10 (Docs) Update README.md with minor grammatical fixes.
181 This library aims to support and is [tested against][travis] the following Ruby implementations:
a7640733 »
2011-11-21 Convert README to ASCII English text
182
183 * Ruby 1.8.7
184 * Ruby 1.9.2
185 * Ruby 1.9.3
8206f1cb »
2011-12-01 Cleanup readme
186 * [Rubinius][]
576e3e4c »
2012-03-29 Remove REE support (EOL imminent)
187 * [JRuby][]
8206f1cb »
2011-12-01 Cleanup readme
188
189 [rubinius]: http://rubini.us/
576e3e4c »
2012-03-29 Remove REE support (EOL imminent)
190 [jruby]: http://jruby.org/
Something went wrong with that request. Please try again.