Go to file
Ryo H 63970d9b01 Fixed typo in guides/README.md 2024-03-28 21:51:23 +09:00
.devcontainer Use the Rails org ruby image in the Rails devcontainer 2024-03-22 09:23:08 -04:00
.github Updated the pull request template, grammatical and general wordings 2024-03-12 22:17:17 +05:30
actioncable Fix md label-lists rendering incorrectly 2024-03-06 18:11:14 -05:00
actionmailbox Deprecate `ConnectionPool#connection` 2024-03-01 14:32:55 +01:00
actionmailer Register autoload for ActiveJob::Arguments 2024-02-13 20:34:10 +00:00
actionpack Merge pull request #51357 from yahonda/ruby_chilled_strings 2024-03-26 22:45:32 +09:00
actiontext Action Text documentation in now in Markdown 2024-01-25 20:47:14 +00:00
actionview Do not build View watcher until the first `updated?` check 2024-03-12 16:30:29 +00:00
activejob Update test suite for compatibility with Ruby 3.4-dev 2024-02-16 11:55:44 +01:00
activemodel Update test suite for compatibility with Ruby 3.4-dev 2024-02-16 11:55:44 +01:00
activerecord Remove delegate_missing_to in FutureResult class and add test cases. 2024-03-27 17:58:12 +08:00
activestorage Don't enqueue jobs to process a preview image if no variant requires it 2024-03-20 07:37:32 +01:00
activesupport Updating Astana with a Western Kazakhstan timezone 2024-03-12 17:42:16 -07:00
guides Fixed typo in guides/README.md 2024-03-28 21:51:23 +09:00
railties Conditionally skip test job in ci.yml (#51289) 2024-03-25 13:55:20 -07:00
tasks Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
tools Remove `tools/profile` 2024-02-27 20:43:30 +01:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Add preview_docs rake task for generating API and Guides static site 2024-02-13 13:05:49 +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 Enable `Layout/DefEndAlignment` cop 2024-01-15 11:00:32 +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 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 Delete `EncryptionPerformanceTest` 2024-02-06 18:05:31 +01:00
Gemfile.lock Marcel 1.0.4 2024-03-01 09:29:24 -08: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 Add preview_docs rake task for generating API and Guides static site 2024-02-13 13:05:49 +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 Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01: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.