commit dc2c316246b532bfd86b6160fd8222b371568d8c Author: Andrew Coleman Date: Wed Dec 2 22:16:20 2009 -0600 adding thunderdome into git diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f2e0af1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2009 Andrew Coleman + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..3ff734b --- /dev/null +++ b/README.markdown @@ -0,0 +1,96 @@ +# Welcome to the ThunderDome + +This is an administrative panel for Rails styled models. In a nutshell, this application shows you a bunch of models in a list and lets you perform basic filtering, paginated displays and the usual edit/update/destroy functions. + +The ThunderDome is released under the MIT license. See the `LICENSE` file for the complete text. + +## Requirements + +* Ruby +* Sinatra +* HAML +* Web browser with or without JavaScript support + +## Paginated Viewing + +All models get paginated views. 100 records per-page. Filtering is available. It's all basic, but it really gets the job done and gets out of your way. + +Sorting, by default, is `id ASC`. If you would like to change it, add a class method called `custom_order` that returns a string of the order you would like to use. + +## Creation And Editing + +The ThunderDome will introspect all of the objects and infer what needs to be done on each model and build a form with all of the attributes listed in alphabetical order. If a column is a boolean, it displays a checkbox, strings get a text field and texts get a text area. Parent model relationships (yes, it does those!) get a select. + +## Has-Many / Belongs-To's + +It will handle parent-child relationships. In the child paginated views, it will display the parent's ID as an integer, but it's an abbreviation and as long as your model responds to `to_s` it will put that into the full definition in the `` tag. In the edit view, it will provide a `