Go to file
2024-05-24 11:49:36 +05:00
.devcontainer Upgrade devcontainer to use 3.3.1 2024-04-23 21:02:00 +00:00
.github Merge pull request #51791 from duduribeiro/add-name-to-devcontainer-compose 2024-05-13 14:10:47 -04:00
actioncable Clean CHANGELOG for 8.0 2024-05-13 16:55:52 +00:00
actionmailbox Clean CHANGELOG for 8.0 2024-05-13 16:55:52 +00:00
actionmailer Clean CHANGELOG for 8.0 2024-05-13 16:55:52 +00:00
actionpack fix colspan for HtmlTableFormatter and dynamic search for routes 2024-05-24 11:49:36 +05:00
actiontext Merge branch 'rm-trix' 2024-05-16 19:26:43 +00:00
actionview Remove support for oracle, sqlserver and JRuby specific database adapters from the new and db:system:change commands. The supported options are sqlite3, mysql, postgresql and trilogy. 2024-05-13 14:07:47 -04:00
activejob Add regression test for memoized queue adapter 2024-05-14 13:06:48 -04:00
activemodel Clean CHANGELOG for 8.0 2024-05-13 16:55:52 +00:00
activerecord Address Layout/IndentationWidth cop offenses 2024-05-18 07:49:08 +09:00
activestorage Clean CHANGELOG for 8.0 2024-05-13 16:55:52 +00:00
activesupport Merge pull request #51856 from yahonda/restore_warning_condition_for_ruby34 2024-05-21 08:46:51 +09:00
guides Merge pull request #51833 from akhilgkrishnan/remove-unnecessary-changes 2024-05-16 10:21:59 -03:00
railties Merge pull request #51838 from jeromedalbert/no-kamal-storage-volume-if-not-needed 2024-05-21 08:46:26 +09:00
tasks Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
tools Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.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 Fix rubocop 2024-05-13 18:04:01 +00: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 Revert "Pin minitest version to 5.21" 2024-05-15 18:05:43 -04:00
Gemfile.lock Revert "Pin minitest version to 5.21" 2024-05-15 18:05:43 -04:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
package.json Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
RAILS_VERSION Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
rails.gemspec Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
Rakefile Fix Rake :preview_docs tarball 2024-04-26 16:13:01 +09: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
version.rb Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
yarn.lock test: update karma npm from 3.1.4 to 6.4.2 2024-04-18 17:48:59 +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.