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
2011-06-05 20:36:09 -07:00
actionmailer Merge branch 'master' of git://github.com/lifo/docrails 2011-05-25 22:48:47 +02:00
actionpack Remove trailing white-spaces 2011-06-05 10:34:40 -05:00
activemodel fix incorrect output 2011-06-04 20:12:25 +05:30
activerecord Remove trailing white-spaces 2011-06-05 10:34:40 -05:00
activeresource annotate class_eval method for active resource schema attributes 2011-06-05 21:44:04 +05:30
activesupport Remove trailing white-spaces 2011-06-05 10:34:40 -05:00
bin Add railties to the LOAD_PATH if running from a Rails checkout 2011-04-03 19:18:57 -03:00
ci more "SSL everywhere" for GitHub URLs 2011-03-07 06:18:32 +09:00
railties Change http://api.rubyonrails.com to http://api.rubyonrails.org 2011-06-05 20:36:09 -07:00
tasks adding a rake task to help generate changelog notes for release announcements 2011-04-18 14:44:12 -07:00
tools Support an extra profile printer arg 2010-06-24 01:08:12 -07:00
.gitignore (temporary hack) generate a main file for RDoc escaping "Rails" 2011-05-01 13:15:15 +02:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
Gemfile Also use double quotes for #source 2011-05-24 13:29:29 -07:00
install.rb Add install script for testing gems locally 2010-07-26 16:09:10 -05:00
load_paths.rb Remove rescue as it was clobbering the real error. 2011-04-15 18:43:21 +02:00
rails.gemspec Not updating rubyforge for new versions. Result of "gem list -d rails" is not useful. 2011-05-20 17:43:40 +05:30
RAILS_VERSION Bump versions for rc1 2011-05-21 20:56:52 -05:00
Rakefile Ensure RDoc::Task exists even if 'rdoc/task' was not required 2011-05-26 01:37:34 +09:00
README.rdoc Replace old wording about http requests 2011-05-25 07:31:45 -05:00
version.rb Bump versions for rc1 2011-05-21 20:56:52 -05: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 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. ActiveRecord 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:files/activerecord/README_rdoc.html].

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 the 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:files/actionpack/README_rdoc.html].

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

== License

Ruby on Rails is released under the MIT license.