The documentation is compiled from the markdown files in the
sails-docs repo on github. A number of Sails users have expressed interest in emulating the process we use to generate the pages on the Sails website. Good news is it's pretty simple: The compilation process for the Sails docs involves generating HTML from Markdown files in the sails-docs repo, then performing some additional transformations such as adding data type bubbles, tagging permalinks for individual sections of pages, building JSON data to power the side navigation menu and setting HTML
<title> attributes for better search engine discoverability of individual doc pages. See the doc-templater module for more information.
The documentation on the main website is for the latest stable npm release of Sails, and is mirrored by the master branch of the
sails-docs repo on github (Master is sometimes a few commits ahead, but any critical documentation updates make it onto the website within a day or two.)
For older releases of Sails that are still widely used, the documentation is compiled from the relevant
sails-docs branches and hosted on the following subdomains:
There are many different ways to contibute to Sails; for example you could help us improve the official documentation, write a plugin, answer StackOverflow questions, start a Sails meetup, help troubleshoot GitHub issues, write some tests, or submit a patch to Sails core or one of its dependencies. Please look through the contribution guide before you get started. It's a short read that covers guidelines and best practices that ensure your hard work will have the maximum impact.
The Sails project tracks bug reports in GitHub issues and uses pull requests for feature proposals. Please read the contribution guide before you create an issue, submit a proposal, or begin working on pull request.
Unless you are a contributor running a pre-release version of the framework in order to do some testing or work on core, you should use the latest stable version of Sails from NPM (click the badge above). Installing is easy- just follow these instructions.
Note: to install/upgrade to the latest version of Sails locally in an existing project, run
npm install [email protected] --force. If you are having trouble and are looking for a bazooka, you might also want to run
rm -rf node_modules && npm cache clear && npm install [email protected] --force && npm install.
If you are looking to install a pre-release version of Sails, you can install from the
beta tag on npm (i.e.
npm install [email protected]). This is a great way to try out a coming release ahead of time and start upgrading before the release becomes official. The beta npm release candidate corresponds with the
beta branch in the Sails repo.
Finally, if you like living on the edge, or you're working on adding a feature or fixing a bug in Sails, install the edge version from the
master branch on github. The edge version is not published on the registry since it's constantly under development, but you can still use npm to install it (e.g.
npm install [email protected]://github.com/balderdashy/sails.git)
For more instructions on installing the beta and edge versions of Sails, check out the contribution guide.
Start with NPM's helpful troubleshooting guide. If you continue to have problems, and you've tried Google searching but you're still stumped, please carefully review the updated Sails contribution guide and then create a GitHub issue in the Sails repo.
We have learned again and again over the years to take versioning of dependencies very seriously. We lock Sails' dependency versions and only bump those versions if the associated updates fix a security issue or present other substantive advantages to Sails users (improved compatibility, performance, etc.) In addition, the core maintainers of Sails are committed fixing any major security, performance, or stability bugs that arise in any of our core dependencies-- regardless of whether those modules are officially maintained by another entity or not.
Sails is tested with node versions 0.10.x and up, and built on the rock-solid foundations of Express and Socket.io. Out of the box, it also depends on other great modules, like
fs-extra. Click the badge above for the full list of dependencies.
Aside from the official documentation, be sure and check out the Support page on the Sails website, and pop in to our Gitter chat room. If you're stumped, make sure and ask a question on StackOverflow, where there's an active Sails community. Members of our core team recently taught a free video course on Platzi and wrote a book. If you're a Flagship support member, you can submit a ticket here.
Sails is used in production by individuals and companies, non-profits, and government entities all over the world, for all sorts of projects (greenfield and mature). This small list is definitely not authoritative, so if you're using Sails in your app/product/service, we'd love to hear about it! You can submit a pull request updating this list here. (We just ask that you respect the order in which projects/companies have been submitted, and add yours to the end of the list.)
The Sails Company (the core maintainers of the framework) offers professional support subscriptions through Sails Flagship. You can learn more about our plans at sailsjs.com/flagship.
If you are the author of a tutorial or guide about Sails, please send us a pull request here and we'll check it out. (Be sure to add your tutorial to the top of the applicable list, as we try to order these from newest to oldest.)
- If you are the author of an article about Sails, please send us a pull request here. We'll check it out!
- If you are a company interested in doing a press release about Sails, please contact @mikermcneil on Twitter (and er.. remind him if necessary!) We'll do what we can to help.