Skip to content
Ruby on Rails
Ruby HTML JavaScript CSS CoffeeScript Shell
Branch: master
Clone or download
fxn let zeitwerk:check report files outside the root directory with absol…
…ute paths

This may happen in engines loaded as gems, for example.

Closes #37285.
Latest commit 3ac9e22 Sep 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update stale issue comment to mention 6-0-stable Aug 28, 2019
actioncable Renamed method in documentation string `assert_broadcasts_on` to the Sep 23, 2019
actionmailbox Fix typo in ActionMailbox::InboundEmail::MessageId [ci skip] Sep 17, 2019
actionmailer Fix keyword arguments warnings Sep 9, 2019
actionpack Fix typo in actionpack changelog, `a HTTP` -> `an HTTP` [ci skip] Sep 23, 2019
actiontext form_with takes keyword arguments Sep 24, 2019
actionview template_exists? takes keyword arguments Sep 24, 2019
activejob Fix queue adapter class delegation to point to `self.class` Sep 24, 2019
activemodel AMo::Error#initialize takes keyword arguments Sep 14, 2019
activerecord t.string takes keyword arguments Sep 24, 2019
activestorage Fix typo /a HTTP/an HTTP/ [ci skip] Sep 23, 2019
activesupport Unify rotate method definitions to take keyword arguments Sep 24, 2019
ci Use webdrivers instead of chromedriver-helper for AV UJS tests Mar 24, 2019
guides Add missing OS dependency (#37263) Sep 22, 2019
railties let zeitwerk:check report files outside the root directory with absol… Sep 24, 2019
tasks Fix announce script Mar 22, 2019
tools Enable `Layout/EmptyLinesAroundAccessModifier` cop Jun 13, 2019
.codeclimate.yml Bump RuboCop to 0.74.0 Aug 15, 2019
.gitattributes adds .gitattributes to enable Ruby-awareness Mar 16, 2016
.gitignore Output junit format test report Apr 4, 2019
.rubocop.yml Do not enforce no braces for hash argument Sep 3, 2019
.travis.yml Install JavaScript packages before run test Feb 11, 2019
.yardopts Let YARD document the railties gem Sep 10, 2010
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) Oct 1, 2018
Brewfile [ci skip] Add ImageMagick to Brewfile Aug 22, 2018
CODE_OF_CONDUCT.md Updated links from http to https in guides, docs, etc Mar 9, 2019
CONTRIBUTING.md Updated links from http to https in guides, docs, etc Mar 9, 2019
Gemfile Required mysql2 gem 0.5.0 Sep 13, 2019
Gemfile.lock Required mysql2 gem 0.5.0 Sep 13, 2019
MIT-LICENSE Bump license years for 2019 Dec 31, 2018
RAILS_VERSION Start Rails 6.1 development Apr 24, 2019
README.md Update README.md Jul 30, 2019
RELEASING_RAILS.md NPM -> npm [ci skip] May 12, 2019
Rakefile Use frozen string literal in root files Aug 13, 2017
package.json Install JavaScript packages before run test Feb 11, 2019
rails.gemspec Import Action Text Jan 5, 2019
version.rb Start Rails 6.1 development Apr 24, 2019
yarn.lock Fix outdated yarn.lock Apr 25, 2019

README.md

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

    Run with --help or -h for options.

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

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

Contributing

Code Triage Badge

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.

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.

You can’t perform that action at this time.