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
Joe Marty 3376ab8055
Clarify session management middleware sections
Addresses some comments in original PR for docs on using session management middleware in API apps
2019-12-26 09:25:47 -06:00
.github Add a note about adding CHANGELOG entries at the top of the file [ci skip] 2016-07-02 22:31:09 +05:30
actioncable Move some ActionCable logs to debug level 2017-02-06 12:05:54 +01:00
actionmailer Freeze fragment cache related instrument name. 2017-02-07 00:41:02 +08:00
actionpack Merge pull request #27926 from st0012/freeze-cache-instrument-name 2017-02-13 20:53:39 -03:00
actionview Add Style/EmptyLinesAroundMethodBody in .rubocop.yml and remove extra empty lines 2017-02-12 20:44:15 +09:00
activejob remove ActiveSupport.halt_callback_chains_on_return_false from everywhere 2017-02-08 17:24:49 +09:00
activemodel Remove unused require 2017-02-12 19:38:49 -07:00
activerecord Remove unused DdlHelper in ForeignKeyTest 2017-02-14 23:47:48 +09:00
activesupport Not ants were harmed! 🐜 2017-02-14 12:05:21 +01:00
ci Add more rubocop rules about whitespaces 2016-10-29 01:17:49 -02:00
guides Clarify session management middleware sections 2019-12-26 09:25:47 -06:00
railties Remove unused require 2017-02-12 19:38:49 -07:00
tasks modernizes hash syntax in the rest of the project 2016-08-06 19:40:54 +02:00
tools make work bin/test scripts with line filter 2016-12-17 18:08:57 +09:00
.codeclimate.yml Generators and tests are under the same style rules 2016-07-27 20:26:39 -03:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore [ci skip] Add .byebug_history to .gitignore 2017-01-11 14:29:07 +03:00
.rubocop.yml Add Style/EmptyLinesAroundMethodBody in .rubocop.yml and remove extra empty lines 2017-02-12 20:44:15 +09:00
.travis.yml Add sqlite3_mem adapter to Travis CI 2017-01-31 16:23:13 +00:00
.yardopts
CODE_OF_CONDUCT.md Move the CoC text to the Rails website 2015-08-21 12:32:59 -07:00
CONTRIBUTING.md Add notes on cosmetic patches 2016-05-13 15:03:50 -04:00
Gemfile Use released resque 2017-02-10 15:31:41 +09:00
Gemfile.lock Test with the newest i18n 2017-02-11 06:12:07 +09:00
MIT-LICENSE Bump license years for 2017 2016-12-31 08:34:08 -05:00
rails.gemspec applies new string literal convention in the gemspecs 2016-08-06 19:27:12 +02:00
RAILS_VERSION Start Rails 5.1 development 🎉 2016-05-10 03:46:56 -03:00
Rakefile Remove Faye mode 2016-10-01 15:35:59 +09:30
README.md Fix title of README according to Markdown conventions 2016-02-25 03:39:02 +01:00
RELEASING_RAILS.md Update RELEASING_RAILS.md for rails-ujs 2016-11-26 10:51:44 -05:00
version.rb Start Rails 5.1 development 🎉 2016-05-10 03:46:56 -03:00

Welcome to 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, each with a specific responsibility.

The Model layer represents your domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic that is 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. You can read more about Active Record in its README. 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. You can read more about Active Model in its README.

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. You can read more about Action Pack in its README.

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. You can read more about Action View in its README.

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 (README), a library to generate and send emails; Active Job (README), a framework for declaring jobs and making them run on a variety of queueing backends; Action Cable (README), a framework to integrate WebSockets with a Rails application; and Active Support (README), 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
     $ rails server
    

    Run with --help or -h for options.

  4. Using a browser, go to http://localhost:3000 and you'll see: "Yay! Youre on Rails!"

  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!

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.

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.