Total Pageviews

Sunday, 7 August 2016


Realtime MVC Framework for Node.js 

Website   Getting Started    Docs   Blog   Submit Issue

NPM version   Gitter   Twitter Follow
Sails.js is a web framework that makes it easy to build custom, enterprise-grade Node.js apps. It is designed to resemble the MVC architecture from frameworks like Ruby on Rails, but with support for the more modern, data-oriented style of web app development. It's especially good for building realtime features like chat.


With node installed:
# Get the latest stable release of Sails
$ npm install sails -g
Upgrading from 0.10 or 0.11?
The v0.12 release of Sails contains a few breaking changes which affect userland. To read the v0.12 migration guide, click here.

Your First Sails Project

Create a new app:
# Create the app
$ sails new testProject
Lift sails:
# cd into the new folder
$ cd testProject

# fire up the server
$ sails lift
Generate a REST API:


Sails is built on Node.jsConnectExpress, and
Sails controllers are compatible with Connect middleware, so in most cases, you can paste code into Sails from an existing Express project and everything will work-- plus you'll be able to use WebSockets to talk to your API, and vice versa.
The ORM, Waterline, has a well-defined adapter system for supporting all kinds of datastores. Officially supported databases include MySQLPostgreSQLMongoDBSQLite3Redis, local disk, and local memory.  Community adaptersexist for CouchDBneDBTingoDBSQLiteOracleMSSQLDB2ElasticSearchRiakneo4jOrientDBAmazon RDSDynamoDBAzure TablesRethinkDB and Solr; for various 3rd-party REST APIs like Quickbooks, Yelp, and Twitter, including a configurable generic REST API adapter; plus some eclectic projects.
Powered by MySQL                                



Need help or have a question?

Issue Submission

Please read the issue submission guidelines before opening a new issue.
Sails is composed of a number of different sub-projects, many of which have their own dedicated repository. If you suspect an issue in one of these sub-modules, you can find its repo on the organization page, or in Click here to search/post issues in this repository.

Feature Requests

If you have an idea for a new feature, please feel free to submit it as a pull request to the backlog section of the file in this repository.


There are many different ways you can contribute to Sails:
Please carefully read our contribution guide and check the master branch build status before submitting a pull request with code changes.



Sails was built and is actively maintained by Balderdash Design Company (@balderdashy) and The Treeline Company(@treelinehq), with the help of many other amazing contributors. Our core team consists of:
Mike McNeilCody StoltmanScott GressIrl NathanRachael Shaw
Mike McNeilCody StoltmanScott GressIrl NathanRachael Shaw
Back in 2012, we were designing/builing scalable Node.js apps for startups and enterprise customers. After building a few applications and taking them into production, we realized that the Node.js development landscape was very much still the Wild West. Over time, after trying lots of different methodologies, we decided to crystallize all of our best practices into this framework. Four years later, Sails is now one of the most widely-used web application frameworks in the world. We hope it saves you some time! :)