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-01-18 11:26:18 -02:00
actionmailer Upgrade mail dependency to 2.4.0 2012-01-15 22:15:15 +10:30
actionpack Remove redundant mention of escape_javascript alias. 2012-01-16 21:33:19 -08:00
activemodel Add ActiveModel::Errors#delete, which was not available after move to use delegation 2012-01-16 17:23:40 +01:00
activerecord Merge pull request #4480 from lest/use-rack-body-proxy 2012-01-16 08:05:31 -08:00
activeresource require minitest rather than test/unit 2012-01-06 15:50:47 -08:00
activesupport Merge pull request #4432 from lest/patch-1 2012-01-12 15:32:40 -08:00
ci fixed a typo in a message when there is no failuresin a build 2011-11-28 16:45:40 +02:00
railties Update docs for config.assets.logger 2012-01-18 11:26:18 -02:00
tasks rake release should push the tag 2011-11-14 16:55:31 +00:00
tools Support an extra profile printer arg 2010-06-24 01:08:12 -07:00
.gitignore allow people to set a local .Gemfile so that things like ruby-debug are not required for regular development 2011-11-17 14:41:53 -08:00
.travis.yml Update ruby_version_check. 2011-12-20 16:55:01 +01:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
Gemfile use rack from master branch 2012-01-16 14:42:23 +03:00
install.rb Add install script for testing gems locally 2010-07-26 16:09:10 -05:00
load_paths.rb This fixes an issue when bundling to a local path (eg. /vendor/bundle). 2011-07-17 15:21:19 +02:00
rails.gemspec Updated gemspec for ruby 1.9.3 2011-12-21 11:09:01 +05:30
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 Use -e option instead of -c option (rake rdoc task). 2012-01-04 00:54:41 +09:00
README.rdoc Finished implementation of MIT license linking. 2011-12-23 13:03:21 -08:00
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> 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