Go to file
Nathaniel Madura fe309b5223 added a touch more information to the apache configuration instructions
In the text there is a section about how to serve the assets with
far-future headers. The snippet that is proposed doesn't work on Ubuntu
11 (probably others) as mod_expires is not enabled out-of-the-box. I
noted this, and gave an example of how to load mod_expires with a2enmod.
2012-08-29 13:13:58 -04:00
actionmailer Get rid of config.preload_frameworks in favor of config.eager_load_namespaces 2012-08-21 14:47:19 -03:00
actionpack Merge branch 'master' of github.com:lifo/docrails 2012-08-22 23:51:17 +05:30
activemodel Get rid of config.preload_frameworks in favor of config.eager_load_namespaces 2012-08-21 14:47:19 -03:00
activerecord Merge pull request #6606 from amatsuda/ar_relation_model_method 2012-08-21 14:43:19 -07:00
activesupport Add CHANGELOG entry for #3578 [ci skip] 2012-08-21 18:39:37 -03:00
ci remove duplicate build runs in travis. These extra runs were used to 2012-07-24 16:44:20 -07:00
guides added a touch more information to the apache configuration instructions 2012-08-29 13:13:58 -04:00
railties remind user a good way to generate a secret code. 2012-08-21 20:37:58 -07: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 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 Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
Gemfile Replace deprecated memcache-client gem with dalli in ActiveSupport::Cache::MemCacheStore 2012-08-17 22:22:55 -05: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_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
rails.gemspec Add license field to gemspecs, by Matt Griffin 2012-05-23 09:22:25 -07:00
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 proper casing in pronouns; relocate the pro git book [ci skip] 2012-08-11 02:19:51 -04: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