1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Ruby on Rails
Find a file
Jamie Macey 3e67e45dc3 Allow a defining custom member field on resources
By default, resources routes are created with :resource/:id. A model
defining to_param can make prettier urls by using something more
readable than an integer ID, but since the route picks it up as :id you
wind up with awkward User.find_by_username(params[:id]) calls.

By overriding the key to be used in @request.params you can be more
obvious in your intent.
2012-03-25 21:42:18 -07:00
actionmailer Updates ActionMailer Base summary and fixes space in code example. 2012-03-19 20:59:31 -04:00
actionpack Allow a defining custom member field on resources 2012-03-25 21:42:18 -07:00
activemodel Merge pull request #5374 from nertzy/remove_deprecated_partial_path_from_active_model_naming 2012-03-23 05:57:35 -07:00
activerecord Merge branch 'master' of github.com:lifo/docrails 2012-03-24 17:15:10 +05:30
activesupport Merge pull request #5566 from lest/patch-3 2012-03-25 04:16:53 -07:00
ci Remove IdentityMap 2012-03-13 20:08:54 -03:00
guides restores example depicting the use of true or false in regular font 2012-03-25 20:26:35 +02:00
railties Remove useless conditional. 2012-03-25 18:20:40 -07:00
tasks Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
tools Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
.gitignore moves the guides up to the root directory 2012-03-17 08:32:49 -07:00
.travis.yml Remove ARes from the list. 2012-03-14 00:00:34 +01:00
.yardopts
Gemfile switch rack-test in Gemfile to using git protocol 2012-03-16 21:48:25 -04:00
install.rb Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
load_paths.rb Whitespace only: Use single newline at end of file. 2012-01-27 23:24:23 -08:00
rails.gemspec moves the guides up to the root directory 2012-03-17 08:32:49 -07:00
RAILS_VERSION rails/master is now 4.0.0.beta and will only support Ruby 1.9.3+ 2011-12-20 09:30:37 -06:00
Rakefile Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
README.rdoc -h also shows help options. 2012-03-19 17:53:27 +05:30
RELEASING_RAILS.rdoc Remove more references to postgres on the release notes 2012-01-04 17:48:23 -02:00
version.rb rails/master is now 4.0.0.beta and will only support Ruby 1.9.3+ 2011-12-20 09:30:37 -06:00

== 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]!

== Build Status {<img src="https://secure.travis-ci.org/rails/rails.png"/>}[http://travis-ci.org/rails/rails]

== Dependency Status {<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