Go to file
Jonathan Hefner 92dcc9a09f Fix list item numbering on API docs main page [ci-skip]
Follow-up to #47178.

RDoc's Markdown parser requires multi-line list items to use a hanging
indent of at least four spaces.  Otherwise, trailing lines will be
rendered as an independent paragraph, and the next list item will start
a new list.
2023-08-17 16:22:16 -05:00
.devcontainer Run memcached using docker compose on devcontainer 2023-08-05 02:47:45 +00:00
.github Do not codespell yarn.lock 2023-08-17 12:48:20 +02:00
actioncable Introduce capture_emails and capture_broadcasts (#48798) 2023-07-25 06:42:54 +02:00
actionmailbox Added bounce_now_with 2023-06-28 16:17:40 +02:00
actionmailer Update Action View and Dispatch to use Rails::Dom::Testing helpers 2023-08-03 11:17:38 -04:00
actionpack ERB is no longer in use here since c2e756a944fd3ca2efa58bd285c0e75e0b4794ab 2023-08-17 04:46:35 +09:00
actiontext Fix Action Text sanitizer initialization 2023-07-17 15:07:18 -04:00
actionview Handle non-string partial body in ActionView::CollectionCaching 2023-08-14 11:20:43 +02:00
activejob Fix invalid durations in ActiveJob serialization 2023-08-13 11:27:16 +01:00
activemodel Only define attribute methods for class 2023-08-16 18:23:02 -04:00
activerecord Merge pull request #48947 from eileencodes/use-IN-sql-over-OR-with-query-constraints 2023-08-17 15:34:31 -04:00
activestorage Fix code blocks using + instead of <tt> 2023-08-10 13:05:05 -04:00
activesupport Add test coverage for RedisCacheStore with Redis::Distributed / ConnectionPool 2023-08-17 12:34:28 +01:00
guides [skip ci] Testing by line range documentation added in guide 2023-08-15 07:40:17 +05:30
railties Fix list item numbering on API docs main page [ci-skip] 2023-08-17 16:22:16 -05:00
tasks Support VISUAL env var, and prefer it over EDITOR 2023-06-01 20:55:27 -06: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
.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 Add rubocop-md for linting guides snippets 2023-03-15 10:48:19 +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 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 Expand rails route search to all table content 2023-03-03 17:14:33 +11:00
CONTRIBUTING.md Add note about ActiveSupport to CONTRIBUTING.md 2022-11-09 10:26:41 +09:00
Gemfile Use sdoc main branch for edge API docs 2023-08-09 14:17:01 +02:00
Gemfile.lock Add drb, mutex_m and base64 that are bundled gem candidates for Ruby 3.4 2023-08-08 21:08:48 +09:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01: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 Revert "Merge pull request #46817 from yahonda/bump_required_rubygems_version_to_3313" 2023-02-28 08:42:28 +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 🔗 Remove RDoc auto-link from Rails module everywhere 2023-06-23 10:49:30 +09:00
yarn.lock Update yarn.lock 2023-08-05 02:58:39 +00: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.