Go to file
Jean Boussier ad0e3123e1
Merge pull request #51801 from Shopify/refactor-find_by_token_for
2024-05-13 11:38:12 +09:00
.devcontainer Upgrade devcontainer to use 3.3.1 2024-04-23 21:02:00 +00:00
.github Do not trigger devcontainer tests on pull requests 2024-05-12 22:12:09 -04:00
actioncable Let Action Cable's autoloader ignore the version file 2024-04-22 19:58:23 +02:00
actionmailbox Deprecate `ConnectionPool#connection` 2024-03-01 14:32:55 +01:00
actionmailer Remove usage of `OpenStruct` 2024-04-09 21:35:08 +03:00
actionpack Merge pull request #51614 from gmcgibbon/defer_route_drawing 2024-05-12 10:17:57 -04:00
actiontext Merge pull request #51285 from tsvallender/ensure_image_processing_installed_trix 2024-05-02 18:06:07 -03:00
actionview Replace allocations count by GC time in request logs 2024-05-08 23:02:35 +02:00
activejob Active Job: Correctly use the desired test adapter in tests 2024-05-09 17:35:50 +10:00
activemodel Fix tests without assertions in the framework 2024-04-30 23:29:30 +00:00
activerecord Refactor `ActiveRecord::TokenFor` to not rely on relation delegation 2024-05-13 11:28:15 +09:00
activestorage Remove deprecated `config.active_storage.silence_invalid_content_types_warning` 2024-05-01 18:44:30 +00:00
activesupport Replace allocations count by GC time in request logs 2024-05-08 23:02:35 +02:00
guides Remove debug require from guides generator 2024-05-10 18:42:55 +00:00
railties Merge pull request #51614 from gmcgibbon/defer_route_drawing 2024-05-12 10:17:57 -04:00
tasks Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
tools Remove deprecated support for the pre-Ruby 2.4 behavior of `to_time` 2024-05-01 18:44:31 +00:00
.gitattributes
.gitignore Ignore tarball from rake preview_docs 2024-05-01 08:05:42 +09:00
.mdlrc Introduce markdownlint for guides 2023-03-27 12:14:18 +09:00
.mdlrc.rb Introduce markdownlint for guides 2023-03-27 12:14:18 +09:00
.rubocop.yml Remove usage of `OpenStruct` 2024-04-09 21:35:08 +03: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 Remove taps from Brewfile 2024-03-23 21:14:03 -05:00
CODE_OF_CONDUCT.md Trim trailing whitespace from *.md files 2022-12-17 15:27:51 -08:00
CONTRIBUTING.md Replace outdated links with correct links 2023-12-17 13:39:05 +09:00
Gemfile Resolve deprecation warning in latest `selenium-webdriver` 2024-04-26 12:28:42 +02:00
Gemfile.lock Register Rails console commands/helpers with its latest extension APIs 2024-05-01 22:14:53 +00:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
RAILS_VERSION Development of Rails 7.2 starts now 2023-09-27 03:59:11 +00:00
README.md Add markdown codehighlight for bash script 2024-01-04 00:30:50 +05:30
RELEASING_RAILS.md Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
Rakefile Fix Rake :preview_docs tarball 2024-04-26 16:13:01 +09:00
package.json Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
rails.gemspec Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
version.rb Development of Rails 7.2 starts now 2023-09-27 03:59:11 +00:00
yarn.lock test: update karma npm from 3.1.4 to 6.4.2 2024-04-18 17:48:59 +00:00

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.

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.