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-08-17 14:41:49 -07:00
actionmailer Rubygems => RubyGems 2011-08-13 16:22:31 -07:00
actionpack Properly escape glob characters. 2011-08-16 15:28:27 -07:00
activemodel Merge branch 'master' of github.com:lifo/docrails 2011-08-16 11:06:40 -07:00
activerecord prevent sql injection attacks by escaping quotes in column names 2011-08-16 15:24:42 -07:00
activeresource comma is more appropriate here 2011-08-13 16:22:34 -07:00
activesupport properly escape html to avoid invalid utf8 causing XSS attacks 2011-08-16 15:24:58 -07:00
bin
ci Remove cruise files 2011-08-13 16:22:18 -07:00
railties fixes generation of the AR querying guide 2011-08-17 14:41:49 -07:00
tasks Make rails gem build directory consistent with actionpack, etc. 2011-08-04 17:32:43 -04:00
tools
.gitignore we should not ignore all gems in here 2011-08-13 16:22:30 -07:00
.travis.yml Update travis config on @joshk's instructions 2011-08-15 17:23:15 +01:00
.yardopts
Gemfile This dep is already defined in activerecord.gemspec 2011-08-13 16:22:28 -07:00
install.rb
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 Revert "The rails gem doesn't have a lib directory - closes #1958." 2011-07-04 16:59:51 +01:00
RAILS_VERSION Master version is 3.2.0.beta 2011-06-30 10:18:36 -03:00
Rakefile Fixes readme links better - earlier links broke when the current page is anything other than github.com/rails/rails/. Even github.com/rails/rails (without the trailing slash) broke the readme links. Also change the rakefile that generates the rdoc readme accordingly 2011-08-13 22:14:18 +05:30
README.rdoc '/' was outside of anchor tag. 2011-08-13 16:22:11 -07:00
RELEASING_RAILS.rdoc making the order more clear, adding linux distros mailing lists to our cc 2011-08-16 17:39:58 -07:00
version.rb Master version is 3.2.0.beta 2011-06-30 10:18:36 -03: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. 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:/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]!

== License

Ruby on Rails is released under the MIT license.