Welcome to Quails¶ ↑
Quails 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 Quails. MVC divides your application into three layers, each with a specific responsibility.
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).
The Model layer represents your domain model (such as Account
, Product, Person
, Post
) and encapsulates the business logic that is specific to your application. In Quails, 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 Quails 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 ActiveModel
module. You can read more about Active Record
in its README.
The Controller layer is responsible for handling incoming HTTP requests and providing a suitable response. Usually this means returning HTML, but Quails controllers can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers manipulate models and render view templates in order to generate the appropriate HTTP response.
In Quails, the Controller and View layers are handled together by Action Pack. These two layers are bundled in a single package due to their heavy interdependence. This is unlike the relationship between Active Record
and Action Pack, which are independent. Each of these packages can be used independently outside of Quails. You can read more about Action Pack in its README.
Getting Started¶ ↑
-
Install Quails at the command prompt if you haven't yet:
$ gem install quails
-
At the command prompt, create a new Quails application:
$ quails new myapp
where “myapp” is the application name.
-
Change directory to
myapp
and start the web server:$ cd myapp; quails server
Run with
--help
or-h
for options. -
Go to localhost:3000 and you'll see:
"Yay! You’re on Quails!"
-
Follow the guidelines to start developing your application. You may find the following resources handy:
-
The README file created within your application.
Contributing¶ ↑
We encourage you to contribute to Ruby on Quails! Please check out the Contributing to Quails guide for guidelines about how to proceed. Join us!
License¶ ↑
Ruby on Quails is released under the MIT License.