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
2012-08-11 12:48:06 +02:00
actionmailer Revert "Merge pull request #7202 from asanghi/perform_deliveries_in_mail" 2012-08-07 14:00:54 -03:00
actionpack Merge pull request #7314 from schneems/schneems/form_for_error 2012-08-10 20:09:21 -07:00
activemodel Naming helpers should first check if passed object responds to model_name 2012-08-08 22:40:06 +02:00
activerecord fixup guides in light of :dependent changes 2012-08-10 23:45:25 +01:00
activesupport Ensure I18n format values always have precedence over defaults 2012-08-11 00:20:19 -03:00
ci remove duplicate build runs in travis. These extra runs were used to 2012-07-24 16:44:20 -07:00
guides [guides] Add info about CHANGELOGs to contributing guide 2012-08-11 12:48:06 +02:00
railties Move AD default_headers configurations to railtie 2012-08-10 21:11:56 -05:00
tasks Remove Active Resource source files from the repository 2012-03-13 14:55:44 -04:00
tools require "rubygems" is obsolete in Ruby 1.9.3 2012-05-13 14:47:25 +02:00
.gitignore
.travis.yml
.yardopts
Gemfile support relations created with a table alias 2012-07-13 11:44:45 +01: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 Add license field to gemspecs, by Matt Griffin 2012-05-23 09:22:25 -07:00
RAILS_VERSION
Rakefile Rakefile executable attributes and shebang lines has been removed 2012-05-02 13:38:13 +03:00
README.rdoc -h also shows help options. 2012-03-19 17:53:27 +05:30
RELEASING_RAILS.rdoc fixing security email address 2012-06-12 14:34:44 -07: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