tempbottle / sails

Realtime MVC Framework for Node.js

Website   Getting Started   Docs   Submit Issue


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.

Installation  

With node installed:

# Get the latest stable release of Sails
$ sudo npm install sails -g

######New release available The v0.11 release of Sails (with support for Socket.io v1.0) is here! To read the v0.11 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:

Compatibility

Sails is built on Node.js, Connect, Express, and Socket.io.

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 MySQL, PostgreSQL, MongoDB, SQLite3, Redis, local disk, and local memory. Community adapters exist for CouchDB, neDB, TingoDB, SQLite, Oracle, MSSQL, DB2, ElasticSearch, Riak, neo4j, OrientDB, Amazon RDS, DynamoDB, Azure Tables, and RethinkDB; for various 3rd-party REST APIs like Quickbooks, Yelp, and Twitter, including a configurable generic REST API adapter; plus some eclectic projects.

                               

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 Sails sub-modules, you can find its repo on the organization page. Click here to search/post issues in this repository.

Feature Requests

Feel free to submit ideas for a new feature in the sails.js issue tracker.

Contribute

We love pull requests! See the contribution guide to get started.

Books

• Sails.js in Action by Michael R. McNeil and Irl I. Nathan (Manning Publications). Chapter 1

Support

Need help or have a question?

• Tutorials
• StackOverflow
• Gitter Chat Room
• Professional/Enterprise Support

Links

• Website
• Official Documentation
• Changelog
• Roadmap
• Google Group
• Twitter
• SailsCasts

Team

Sails is actively built and maintained by Balderdash (@balderdashy), a realtime web & mobile studio, with the help of these contributors:

Mike McNeil	Cody Stoltman	Scott Gress	Irl Nathan	Rachael Shaw

Balderdash designs/builds scalable Node.js apps for startups and enterprise customers. After building a few apps 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. I hope it saves you some time :)

License

MIT License Copyright © 2012-2015 Mike McNeil

Sails is built around so many great open-source technologies that it would never have crossed our minds to keep it proprietary. We owe huge gratitude and props to TJ Holowaychuk (@visionmedia) and Guillermo Rauch (@rauchg) for the work they did, as well as the stewards of all the other open-source modules we use. Sails could never have been developed without your tremendous contributions to the node community.