Go to file
Jonathan Hefner d156c47018 Hide runner:looks_like_a_file_path?
This prevents `runner:looks_like_a_file_path?` from showing up in the
output of `bin/rails --help`.

__Before__

  ```console
  $ bin/rails --help
  You must specify a command. The most common commands are:

  ...

  In addition to those commands, there are:

  about                              List versions of all Rails frameworks and...
  ...
  runner
  runner:looks_like_a_file_path?
  secret                             Generate a cryptographically secure secre...
  secrets:edit
  ...
  ```

__After__

  ```console
  $ bin/rails --help
  You must specify a command. The most common commands are:

  ...

  In addition to those commands, there are:

  about                              List versions of all Rails frameworks and...
  ...
  runner
  secret                             Generate a cryptographically secure secre...
  secrets:edit
  ...
  ```
2023-01-12 17:10:09 -06:00
.devcontainer Update all the development gems 2023-01-11 22:59:03 +00:00
.github Use Ruby 3.2 for RuboCop workflow 2023-01-05 10:43:08 +09:00
actioncable delegate to: :class has to be defined after the target method 2023-01-11 04:32:08 +09:00
actionmailbox Ignore local .sqlite3 files that are created under storage directory 2022-12-27 11:35:26 +09:00
actionmailer Format inline code [ci-skip] 2023-01-08 15:47:20 -06:00
actionpack Scope generated route helpers to an instance of RoutesProxy 2023-01-12 15:03:57 +01:00
actiontext Prepend a '\n' to the string to be added to application.js to prevent errors occurring when application.js doesn't end in a blank line. 2023-01-02 13:36:03 -08:00
actionview Enable Style/EvalWithLocation 2023-01-11 18:46:09 -05:00
activejob Fix compatability between tests and Sidekiq 6.5 2023-01-08 20:41:59 -05:00
activemodel Merge pull request #46868 from amatsuda/Time.new_string 2023-01-11 03:56:25 +09:00
activerecord ReadOnlyAttribute: no need for code generation 2023-01-12 15:52:56 +01:00
activestorage Fix lots of code highlighting issues 2022-11-29 00:51:02 -05:00
activesupport Enable Style/EvalWithLocation 2023-01-11 18:46:09 -05:00
guides Adding Association Scoping using the Association Owner 2023-01-11 21:00:17 +00:00
railties Hide runner:looks_like_a_file_path? 2023-01-12 17:10:09 -06:00
tasks Update rubocop-performance and enable more performance-related cops 2022-08-26 15:07:11 +03:00
tools Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Remove unnecessary gitignore entry 2022-09-09 22:15:29 +00:00
.rubocop.yml Enable Style/EvalWithLocation 2023-01-11 18:46:09 -05: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 Add libvips to Development Dependency guide 2022-05-01 03:07:21 -04:00
CODE_OF_CONDUCT.md Trim trailing whitespace from *.md files 2022-12-17 15:27:51 -08:00
codespell.txt Migrate Rails Guides from Turbolinks to Turbo 2022-10-17 22:07:33 +02:00
CONTRIBUTING.md Add note about ActiveSupport to CONTRIBUTING.md 2022-11-09 10:26:41 +09:00
Gemfile Upgrade sdoc to support Ruby 3.2 2023-01-11 12:46:46 +01:00
Gemfile.lock Upgrade mail to fixed version 2023-01-12 20:07:02 +00:00
MIT-LICENSE Bump license years to 2022 [ci-skip] 2022-01-01 15:22:15 +09:00
package.json Install JavaScript packages before run test 2019-02-11 09:58:08 +09:00
RAILS_VERSION Start Rails 7.1 development 2021-12-07 15:52:30 +00:00
rails.gemspec Bump required_rubygems_version to 3.3.13 or higher 2022-12-24 10:46:41 +09:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
README.md Convert lib and frameworks to bulleted list-README 2022-02-14 23:15:16 +05:30
RELEASING_RAILS.md Add more instructions to RELEASING_RAILS 2022-09-09 13:37:14 -07:00
version.rb Fix #version docs and some typos 2022-03-16 01:48:37 +05:30
yarn.lock use Karma as the test runner for the UJS tests 2022-12-31 23:03:09 +11: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.

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.

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.

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
  • 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 the Rails bootscreen with your Rails and Ruby versions.

  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.