Ruby on Rails
Go to file
Steve Klabnik b659e00baf Split Validations and Callbacks into separate guides.
Two big features that are only barely related in the same guide. Seems
bad.

I did not check references to these guides yet, so some links may need
to be updated.
2012-11-29 15:03:21 -08:00
actionmailer Tiny refactor 2012-11-29 09:53:25 -02:00
actionpack Merge pull request #8363 from Takehiro-Adachi/add-string-options-examples-to-currentpage-method 2012-11-29 03:04:31 -08:00
activemodel Add CHANGELOG entries for the observes extraction 2012-11-29 01:08:36 -02:00
activerecord Move instantiation responsibilities from Inheritance to Persistence. Have Inheritance#discriminate_class_for_record handle STI lookup duties. 2012-11-29 08:56:09 -07:00
activesupport Add #seconds_until_end_of_day to DateTime and Time 2012-11-29 06:39:32 +01:00
ci remove duplicate build runs in travis. These extra runs were used to 2012-07-24 16:44:20 -07:00
guides Split Validations and Callbacks into separate guides. 2012-11-29 15:03:21 -08:00
railties Gemfile source url for plugins updated 2012-11-29 11:23:32 -05:00
tasks Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
tools Remove REE GC stats since master is 1.9.3 2012-10-26 08:24:27 -07:00
.gitignore moves the guides up to the root directory 2012-03-17 08:32:49 -07:00
.travis.yml Add Ruby 2.0 to .travis.yml. 2012-11-17 13:49:36 +01:00
.yardopts
CONTRIBUTING.md add some kindness 2012-09-18 17:57:37 +02:00
Gemfile Revert "Merge pull request #8341 from amatsuda/bundle_source_rubygems" 2012-11-27 14:59:58 -02:00
RAILS_VERSION
README.rdoc Organize README 2012-10-26 18:50:35 -04:00
RELEASING_RAILS.rdoc proper casing in pronouns; relocate the pro git book [ci skip] 2012-08-11 02:19:51 -04:00
Rakefile Organize README 2012-10-26 18:50:35 -04:00
install.rb Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
load_paths.rb require "rubygems" is obsolete in Ruby 1.9.3 2012-05-13 14:47:25 +02:00
rails.gemspec Revert "rails gem has no lib directory to require" 2012-11-28 10:20:54 -08:00
version.rb

README.rdoc

== Welcome to Rails

Rails is a web-application framework that includes everything needed to create
database-backed web applications according to the {Model-View-Controller (MVC)}[http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller] pattern.

Understanding the MVC pattern is key to understanding Rails. MVC divides your application
into three layers, each with a specific responsibility.

The View layer is composed of "templates" that are responsible for providing
appropriate representations of your application's resources. Templates
can come in a variety of formats, but most view templates are \HTML with embedded Ruby
code (.erb files).

The Model layer represents your domain model (such as Account, Product, Person, Post)
and encapsulates the business logic that is specific to your application. In Rails,
database-backed model classes are derived from ActiveRecord::Base. Active Record allows
you to present the data from database rows as objects and embellish these data objects
with business logic methods. Although most Rails models are backed by a database, models
can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as
provided by the ActiveModel module. You can read more about Active Record in its
{README}[link:/rails/rails/blob/master/activerecord/README.rdoc].

The Controller layer is responsible for handling incoming HTTP requests and providing a
suitable response. Usually this means returning \HTML, but Rails controllers can also
generate XML, JSON, PDFs, mobile-specific views, and more. Controllers manipulate models
and render view templates in order to generate the appropriate HTTP response.

In Rails, the Controller and View layers are handled together by Action Pack.
These two layers are bundled in a single package due to their heavy interdependence.
This is unlike the relationship between Active Record and Action Pack which are
independent. Each of these packages can be used independently outside of Rails. You
can read more about Action Pack in its {README}[link:/rails/rails/blob/master/actionpack/README.rdoc].

== Getting Started

1. Install Rails at the command prompt if you haven't yet:

    gem install rails

2. At the command prompt, create a new Rails application:

    rails new myapp

   where "myapp" is the application name.

3. Change directory to +myapp+ and start the web server:

    cd myapp; rails server

   Run with <tt>--help</tt> or <tt>-h</tt> for options.

4. Go to http://localhost:3000 and you'll see:

    "Welcome aboard: You're riding Ruby on Rails!"

5. Follow the guidelines to start developing your application. You may find the following resources handy:

* The README file created within your application.
* The {Getting Started with Rails}[http://guides.rubyonrails.org/getting_started.html].
* The {Ruby on Rails Tutorial}[http://railstutorial.org/book].
* The {Ruby on Rails Guides}[http://guides.rubyonrails.org].
* The {API Documentation}[http://api.rubyonrails.org].

== Contributing

We encourage you to contribute to Ruby on Rails! Please check out the {Contributing to Rails
guide}[http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html] for guidelines about how
to proceed. {Join us}[http://contributors.rubyonrails.org]!

== Code Status

* {<img src="https://secure.travis-ci.org/rails/rails.png"/>}[http://travis-ci.org/rails/rails]
* {<img src="https://gemnasium.com/rails/rails.png?travis"/>}[https://gemnasium.com/rails/rails]

== License

Ruby on Rails is released under the {MIT License}[http://www.opensource.org/licenses/MIT].