No description, website, or topics provided.
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db
doc
lib/tasks
public
script
test
tmp/stylesheets
vendor/plugins
.gitignore
Gemfile
Gemfile.lock
README.markdown
Rakefile
config.ru

README.markdown

Dependencies

System

  • git
  • ruby (works in 1.8.7, should work (not tested) in 1.9.*)
  • sqlite3

RubyGems

  • rails 3 beta (technically you should not have to install this system-wide, but it will make things easier if you do: [sudo] gem install rails --pre)
  • bundler (handles installing everything else)

Getting Started

  1. clone the project
    • type cd ~/code
    • type git clone -o github git://github.com/ravinggenius/orms.git
      • this will create a directory called orms (feel free to rename it)
  2. change into the project directory
  3. type bundle install
    • this will make sure every dependency in Gemfile is resolved and available
  4. start hacking!
    • if you have rails 3 installed system-wide, you can run rails to see available commands, otherwise use script/rails

Coding Standards

  • tests are good and should remain passing to the extent possible
  • 2 spaces indents
    • technically ruby doesn't care about indentation or whether spaces or tabs are used
      • however 2 space indents are the de facto standard that nearly every rubyist on the planet follows
    • sass requires space-based indentation (no tabs!), and 2 spaces seems to be the norm
    • scss doesn't care about about indentation (it uses { and }), but indenting really helps with readability
  • style selectors should be one per line
    • (optionally) unless there are many selectors for the declared style
  • ruby def statements should wrap arguments with parentheses
    • parentheses should be left off if no arguments are accepted

Features

  • ...

To Do

  • add features and update to do and wish lists

Wish List

  • contributers! :)