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
Jonathan Hefner a44fbb5dca
Merge pull request #43138 from p8/guides/use-headings-for-configuration-options
Use headings for configs in Configuration guide [ci-skip]
2021-09-02 15:03:24 -05:00
.github [ci skip] Mention executable test cases in issue template 2021-06-01 11:51:31 -07:00
actioncable Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
actionmailbox Tweak unreachable assertion tests in the block of assert_raises 2021-08-17 20:33:08 +09:00
actionmailer Standardize nodoc comments 2021-07-29 21:18:07 +00:00
actionpack Use static message when raising HTTP request parameter parse errors 2021-08-28 11:56:05 -05:00
actiontext Eliminate some Integer() rescue nil patterns in Action Text 2021-08-26 19:39:44 +02:00
actionview Merge pull request #43106 from flavorjones/flavorjones-activesupport-number-converter-valid-float 2021-08-26 15:41:10 +02:00
activejob Handle NullObject instances in Active Job query tag 2021-08-24 15:07:20 +02:00
activemodel Don't add attribute_names to ActiveModel::Serialization public API 2021-08-28 11:56:21 -07:00
activerecord Merge pull request #43101 from yahonda/diag80548 2021-08-29 13:23:44 +09:00
activestorage Merge pull request #43119 from brian-kephart/main 2021-08-28 20:47:45 -07:00
activesupport Revise private docs of AS::Dependencies 2021-09-02 19:41:21 +02:00
ci chore: Use e.g. which is the more used spelling 2021-07-21 09:17:54 +09:00
guides Merge pull request #43138 from p8/guides/use-headings-for-configuration-options 2021-09-02 15:03:24 -05:00
railties No need to have special accomodations for a github version in dev/edge/main (#43139) 2021-08-31 22:57:34 +02:00
tasks Fix a rubocop offence for Lint/ErbNewArguments 2021-02-05 12:39:58 +09:00
tools Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
.gitattributes
.gitignore Remove non-project specific entry from gitignore 2021-03-22 22:02:00 +00:00
.rubocop.yml Tweak unreachable assertion tests in the block of assert_raises 2021-08-17 20:33:08 +09:00
.yardopts Updating .yardopts to document .rb files in [GEM]/app 2019-08-20 13:25:36 -04:00
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
Brewfile Address Error: caskroom/cask was moved. Tap homebrew/cask-cask instead. 2019-12-18 18:50:57 +09:00
CODE_OF_CONDUCT.md Updated links from http to https in guides, docs, etc 2019-03-09 16:43:47 +05:30
codespell.txt Add spell checking with codespell as a GitHub Action 2021-05-04 14:46:21 +10:00
CONTRIBUTING.md Adding badges and logo to README and CONTRIBUTING page 2021-01-20 10:53:47 +01:00
Gemfile Remove default reliance on Sass and CSS generators (#43110) 2021-08-26 13:40:25 +02:00
Gemfile.lock Depends on Zeitwerk 2.5.0.beta3 2021-09-01 15:31:04 +02:00
MIT-LICENSE Bump license years to 2021 [ci skip] 2021-01-01 12:21:20 +09:00
package.json Install JavaScript packages before run test 2019-02-11 09:58:08 +09:00
rails.gemspec Rails 7 requires Ruby 2.7 and prefer Ruby 3+ 2021-02-04 16:34:53 +00:00
RAILS_VERSION Rails 6.2 is now Rails 7.0 2021-02-04 16:47:16 +00:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
README.md Adding badges and logo to README and CONTRIBUTING page 2021-01-20 10:53:47 +01:00
RELEASING_RAILS.md Update missing Rails mailing list URLs 2021-08-29 23:11:47 +02:00
version.rb Rails 6.2 is now Rails 7.0 2021-02-04 16:47:16 +00:00
yarn.lock Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00

Welcome to Rails

What's Rails?

Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Controller (MVC) pattern.

Understanding the MVC pattern is key to understanding Rails. MVC divides your application into three layers: Model, View, and Controller, each with a specific responsibility.

Model layer

The Model layer represents the domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic 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 Active Model module.

Controller layer

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 load and manipulate models, and render view templates in order to generate the appropriate HTTP response. In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and controller classes are derived from ActionController::Base. Action Dispatch and Action Controller are bundled together in Action Pack.

View layer

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). Views are typically rendered to generate a controller response or to generate the body of an email. In Rails, View generation is handled by Action View.

Frameworks and libraries

Active Record, Active Model, Action Pack, and Action View can each be used independently outside Rails. In addition to that, Rails also comes with Action Mailer, a library to generate and send emails; Action Mailbox, a library to receive emails within a Rails application; Active Job, a framework for declaring jobs and making them run on a variety of queuing backends; Action Cable, a framework to integrate WebSockets with a Rails application; Active Storage, a library to attach cloud and local files to Rails applications; Action Text, a library to handle rich text content; and Active Support, a collection of utility classes and standard library extensions that are useful for Rails, and may also be used independently outside Rails.

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
     $ bin/rails server
    

    Run with --help or -h for options.

  4. Go to http://localhost:3000 and you'll see: "Yay! Youre on Rails!"

  5. Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

We encourage you to contribute to Ruby on Rails! Please check out the Contributing to Ruby on Rails guide for guidelines about how to proceed. Join us!

Trying to report a possible security vulnerability in Rails? Please check out our security policy for guidelines about how to proceed.

Everyone interacting in Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Rails code of conduct.

License

Ruby on Rails is released under the MIT License.