1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Ruby on Rails
Find a file
Jonathan Hefner 54d866b000
Merge pull request #45375 from philippneugebauer/main
add repo link for scaffold templates to docs [ci-skip]
2022-06-17 12:50:51 -05:00
.devcontainer Change github to GitHub 2022-03-30 05:55:48 +10:00
.github ci: add GitHub token permissions 2022-05-21 19:23:41 -07:00
actioncable Connections Map changed to Each in ping task 2022-06-16 13:20:14 +02:00
actionmailbox Merge pull request #45206 from jonathanhefner/puma-config-omit-workers-and-preload_app 2022-06-03 17:12:36 -05:00
actionmailer Merge pull request #44777 from jean-francois-labbe/main 2022-05-03 10:47:38 -05:00
actionpack Fix references to RequestHelpers methods in docs 2022-06-14 18:08:13 -04:00
actiontext Omit workers and preload_app! from Puma config 2022-06-03 12:38:21 -05:00
actionview Remove the multi-call form of assert_called_with 2022-06-16 11:13:57 -04:00
activejob Add more detailed description to job generator 2022-06-13 14:44:28 -05:00
activemodel Use const_get to get validator classes 2022-06-01 17:14:45 +09:00
activerecord Merge pull request #44945 from fatkodima/optimize-batches 2022-06-17 15:54:32 +02:00
activestorage Fix #41661 attaching multiple times within transaction 2022-06-06 21:23:33 -07:00
activesupport Remove the multi-call form of assert_called_with 2022-06-16 11:13:57 -04:00
ci ✂️ 2021-10-14 16:36:56 +00:00
guides Merge pull request #45375 from philippneugebauer/main 2022-06-17 12:50:51 -05:00
railties Merge pull request #45380 from seejohnrun/remove-multi-use-assert_called_with 2022-06-16 17:54:01 -04:00
tasks Provide change summary before details for all gems 2022-02-09 18:40:54 +08:00
tools Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
.gitattributes
.gitignore Rotate the debug.log on each 100MB 2022-04-13 15:38:19 +03:00
.rubocop.yml Enable Style/MapToHash cop 2022-02-26 04:31:03 +09:00
.yardopts Updating .yardopts to document .rb files in [GEM]/app 2019-08-20 13:25:36 -04:00
.yarnrc
Brewfile Add libvips to Development Dependency guide 2022-05-01 03:07:21 -04:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2022-01-18 11:22:46 -05:00
codespell.txt Fix misspelling of value is tests 2022-02-15 14:50:33 +01:00
CONTRIBUTING.md Fix 404 links on https://rubyonrails.org/ [ci-skip] 2021-12-17 02:26:34 +09:00
Gemfile Lock minitest for now 2022-06-15 12:24:41 -04:00
Gemfile.lock Lock minitest for now 2022-06-15 12:24:41 -04:00
MIT-LICENSE Bump license years to 2022 [ci-skip] 2022-01-01 15:22:15 +09:00
package.json
rails.gemspec Fix gemspec 2021-11-15 21:06:21 +00:00
RAILS_VERSION Start Rails 7.1 development 2021-12-07 15:52:30 +00:00
Rakefile
README.md Convert lib and frameworks to bulleted list-README 2022-02-14 23:15:16 +05:30
RELEASING_RAILS.md Upgrade Release guide to match current practices 2022-05-18 23:04:29 +00:00
version.rb Fix #version docs and some typos 2022-03-16 01:48:37 +05:30
yarn.lock [ci skip] Added a note about Github Codespaces' warning (#44148) 2022-01-21 09:08:50 -05: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.