Go to file
David Heinemeier Hansson 8397eb24da
Remove rollup and test machinery for rails-ujs (#50535)
This leaves only the final compiled targets in place.
2024-01-02 16:49:36 +01:00
.devcontainer Run memcached using docker compose on devcontainer 2023-08-05 02:47:45 +00:00
.github Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
actioncable Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
actionmailbox Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
actionmailer Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
actionpack bundle update rubocop --conservative (#50515) 2024-01-02 12:49:36 +01:00
actiontext Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
actionview Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
activejob Merge pull request #50491 from byroot/bump-required-ruby 2023-12-31 09:16:59 +01:00
activemodel Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
activerecord Allow overriding SQLite defaults from database.yml (#50460) 2024-01-02 12:52:54 +01:00
activestorage Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
activesupport Switch to new enum syntax in example code [ci-skip] 2024-01-01 21:31:11 -06:00
guides Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
railties Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
tasks Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
tools Merge pull request #50384 from skipkayhil/hm-fix-alphabetical-configuring 2024-01-01 11:37:44 -06: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 Removed Performance/UnfreezeString cop 2023-11-20 20:31:17 +05:30
.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 Replace outdated links with correct links 2023-12-17 13:39:05 +09:00
Gemfile bundle update (#50516) 2024-01-02 16:48:44 +01:00
Gemfile.lock bundle update (#50516) 2024-01-02 16:48:44 +01: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 7.2 starts now 2023-09-27 03:59:11 +00:00
rails.gemspec Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01: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 Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +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

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.