233 lines (165 sloc) 22.5 KB


Where is the documentation?

How does the markdown documentation end up on the Sails website?

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 Sails website repo for more information.

How do I get involved?

There are many different ways to contibute to Sails; for example you could help us improve the official documentation, write a plugin, fix a bug on the website, 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.

Where do I submit ideas? Report issues?

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.

What version of Sails should I use?

NPM version

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 the instructions on the Sails website.

Note: to install/upgrade to the latest version of Sails locally in an existing project, run npm install sails@latest --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 sails@latest --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 sails@beta). 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 sails@git://github.com/balderdashy/sails.git)

For more instructions on installing the beta and edge versions of Sails, check out the contribution guide.

I'm having trouble installing Sails. What should I do?

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.

What are the dependencies of Sails?

Dependency Status

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 grunt, waterline, and fs-extra. Click the badge above for the full list of dependencies.

Where do I get help?

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.

Who else is using Sails.js?

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! Click the edit button in GitHub's UI to submit a pull request updating this list.

Are there professional support options?

The companies below provide custom development, services, training, and/or support for teams building applications on Sails. These groups also happen to be some of our greatest allies, and have made significant contributions to the development and stability of the framework.

Logo of Balderash, the development shop in Austin that created Sails

Facebook icon Twitter icon Dribbble icon Linkedin icon

Sails was built by the team behind Balderdash, an interactive development studio in Austin, TX. Heather and I started the company in 2012, on the promise that Node.js could be used to build production back-end applications from start to finish. We created Sails to support that mission, and years later, the experiment has been a resounding success. As you might expect, we've done a lot of custom Sails+Node.js development, but our team has experience across the full stack, including: advanced interaction design, practical/scalable development of huge HTML 5 applications, and building rich user experiences across many different devices and screen resolutions.

appendTo logo

appendTo is a leader in front-end software solutions, specializing in JavaScript, jQuery, HTML5 and Mobile Development. We offer a variety of solutions for everyone from small businesses to enterprise clientele.

If you would like to see your company added to this section, please tweet @mikermcneil on Twitter.

What are some good community tutorials?

  • If you are the author of a tutorial or guide about Sails, please send us a pull request editing this file. We'll check it out!

How can I convince the other girls/guys on my team?

Articles / interviews / press releases / whitepapers / talks
  • If you are the author of an article about Sails, please send us a pull request editing this file. 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.