Where is the documentation?
- Docs for the latest stable npm release of Sails are on the website
- This is mirrored by the master branch of the
sails-docsrepo on github
- The content in the Github repo is pushed to the website when it is merged into the branch for the current stable Sails release.
- Master is sometimes a few commits ahead, any critical documentation updates make it onto the website within a day or two. http://sailsjs.org/documentation is the go-to place for the most up-to-date information.
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?
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?
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.
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
editbutton in GitHub's UI to submit a pull request updating this list.
- The City of Paris
- 18F (United States)
- The Broad Institute / Human Genome Project
- Cuckoo Quack - An antique clock turned into a notification system
- Portfolio Page - By Isaac T. Wooten
- Insight Replay - Instant replay for athletes and coaches
- Taskboard - a Sails application to mimic "scrum-ban" taskboard
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.
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.
- Follow us on Twitter: @appendto
- Visit us on Facebook
- Subscribe to our Newsletter - The Modern Web Observer
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!
- Guest Post on Segment.io Blog: Webhooks with Slack, Segment, and Sails.js/Treeline
- Twitter Dev Blog: Guest Post: Twitter Sign-In with Sails.js/Treeline
- SailsCasts - Short screencasts that take you through the basics of building traditional websites, single-page/mobile apps, and APIs using Sails. Perfect for both novice and tenured developers, but does assume some background on MVC.
- Jorge Casar: Introduccion a Sails.js
- Postman Blog: Manage your Sails.js server bootstrap code
- Sails.js Development channel on Medium
- Sails.js Course on Plurasight
- Angular + Sails! Help! - Sails Resources Service for AngularJS
- Intro to Sails.js screencast
- Intro to Sails.js - talk @ NodePDX
- Working With Data in Sails.js tutorial on NetTuts
- How to Create a Node.js App using Sails.js on an Ubuntu VPS
- Sails.js - How to render node views via Ajax, single page application, SPA
- Desarrollar Webapps Realtime:
- Angular + Sails.js (0.10.0-rc5) with angular-sails socket.io
- Sails.js and Heroku
- Sails API development (1/2): Datalayer -models, connections, waterline
- Sails API development (2/2): Custom methods, overriding default actions, and related
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.
- Microsoft Case Study: Deploying Sails.js to Azure Web Apps
- InfoWorld: Why Node.js beats Java and .Net for web, mobile, and IoT apps (Speed, scalability, productivity, and developer politics all played a role in AnyPresence’s selection of Sails.js/Node.js for its enterprise development platform)
- Anypresence & Node.js
- TechCrunch: Sails.js Funded by Y-Combinator
- TechRepublic: Build Robust Applications with the Node.js MVC framework
- Mike's interview w/ @freddier and @cvander from Platzi
- Smashing Magazine: Sailing with Sails.js
- Presentation at Smart City Conference & Expo 2015 (George Lu & YJ Yang)
- Sails.js, Treeline and the future of programming (Article | Video | Deck)
- Radio interview with Mike McNeil w/ ComputerAmerica's Craig Crossman
- UI-First API Design & Development: Apigee's I <3 APIs, San Francisco, 2015
- Choosing the right framework for Node.js development
- TechCrunch: Our 10 Favorite Companies From Y Combinator Demo Day
- Sails.js used on the website for the city of Paris
- Pulling the Plug: dotJS (Paris, 2014)
- From Rags to Open Source (All Things Open, Raleigh, 2014)
- SxSW Conference, Austin, TX: (2014 | 2015)
- Scott Gress at NYC Code Camp: United Nations, 2015
- More talks by Mike and the Sails.js core team
- Dessarolo Web: Interview w/ Mike McNeil (Spanish & English--English starts at 1:30)
- CapitalOne blog: Contrasting Enterprise Node.js Frameworks (by Azat Mardan, author of the book "Pro Express.js")
- Alternatives to MongoDB (Chinese article)
- Introducción a Sails.js, un framework para crear aplicaciones realtime
- Austin startup finds success in responsive design
- Interact ATX
- Intro to Sails.js :: Node.js Conf: Italy, 2014
- Startup America
- Recent tweets about Sails.js
- How to use more open source (18F is an office inside the U.s. General Services Administration that helps other federal agencies build, buy, and share efficient and easy-to-use digital services.)
- 18f Open Source Hack Series: Midas
- Express Web Server Advances in Node.js Ecosystem (auch auf Deutsch)
- Sails.js - Awesome MVC for Node.js
- Interview w/ Tim Heckel on InfoQ
- Case Technical Blog
- Sails.js - Une Architecture MVC pour applications real-time Node.js
- Hacker News
- Intro to Sails.js :: Node PDX, Portland, 2014 (Slides)
- Sail.js : un framework MVC pour Node.js
- Sails.js — Build custom, enterprise-level Node.js apps
- Build Custom & Enterprise Node.js Apps with Sails.js
- New tools for web design and development: March 2013
- Sails 0.8.9: A Rails-Inspired Real-Time Node MVC Framework
- 30 Fresh jQuery Tools and Plugins
- Node.js の MVCフレームワーク Sails.js が良さげなので少し試してみた
- InfoWorld: 13 fabulous frameworks for Node.js
- New web design tools that you need to check out
- Live code Sails.js avec Mike McNeil
- #hack4good adds cities and welcomes Sails.js creator to speak and hack in Paris!
- Backend фреймворк SailsJS + BackboneJS + MySQL
- realtime chat with sails and react