MODULES.md
Sails is a large project, with many modular components. Each module is located in its own repository, and in most cases is tested individually.
Below, you'll find an overview of the modules maintained by the core team and community members.
The modules comprising the Sails framework, as well as the other plugins maintained by our core team, are spread across a number of different code repositories. Some modules can be used outside of the context of Sails, while others are not intended for external use.
For more information on the available releases of the Sails framework as a whole, check out the contribution guide.
As of Sails v1, some hooks are no longer included in Sails core. Instead, they're published as standalone packages:
| Hook | Package | Latest Stable Release | Build Status (edge) | Purpose |
|---|---|---|---|---|
orm | sails-hook-orm | Implements support for Waterline ORM in Sails. | ||
sockets | sails-hook-sockets | Implements Socket.io support in Sails. |
These are not all the core hooks in Sails. There are other core hooks built in to the
sailspackage itself (seelib/hooks/). These other, built-in hooks can still be disabled or overridden using the same configuration.
Certain additional hooks are bundled as dependencies of a new Sails app, especially when using the "Web app" template:
| Hook | Package | Latest Stable Release | Build Status (edge) | Purpose |
|---|---|---|---|---|
grunt | sails-hook-grunt | Governs the built-in asset pipeline in Sails. | ||
organics | sails-hook-organics | Evolving library of well-tested, well-documented, and officially supported modules for the most common everyday tasks in apps (e.g. password hashing, emails, billing, etc.) | ||
apianalytics | sails-hook-apianalytics | A Sails hook for logging detailed request metadata and monitoring your API. | ||
dev | sails-hook-dev | A Sails hook that provides diagnostic / debugging information and levers during development. |
| Platform | Package | Latest Stable Release | Build Status (edge) |
|---|---|---|---|
| Browser | sails.io.js-dist | ||
| Node.js | sails.io.js |
The "Web App" template in Sails comes with a lightweight client-side JavaScript wrapper for Vue.js called parasails:
| Package | Latest Stable Release | Build Status (edge) | Platform |
|---|---|---|---|
| sails-disk | Local disk (.tmp/) | ||
| sails-mysql | MySQL | ||
| sails-postgresql | PostgreSQL | ||
| sails-mongo | MongoDB | ||
| sails-redis | Redis |
| Package | Latest Stable Release | Build Status (edge) | Platform |
|---|---|---|---|
| skipper-disk | Local disk (.tmp/uploads/) | ||
| skipper-s3 | Amazon S3 (AWS) |
As of Sails v1.0, core generators are now bundled in sails-generate. All generators can still be overridden the same way. For examples, see below.
| Package | Latest Stable Release | Build Status (edge) |
|---|---|---|
| skipper | ||
| machine | ||
| machine-as-action | ||
| whelk | ||
| captains-log | ||
| anchor | ||
| sails-generate | ||
| waterline-schema | ||
| waterline-utils | ||
| include-all | ||
| reportback | n/a | |
| switchback | ||
| rttc | ||
| @sailshq/lodash | n/a |
The official documentation for the Sails framework is written in Markdown, and is automatically compiled for the Sails website.
| Repo | Purpose |
|---|---|
| sails-docs | Raw content for reference, conceptual, anatomical, and other documentation on the Sails website (in Markdown). |
| www.sailsjs.com | The Sails app that powers sailsjs.com. HTML content is automatically compiled from sails-docs. |
| doc-templater | The module we use to pre-process, compile, and format Markdown documentation files into the HTML markup and tree menus at sailsjs.com/documentation. |
All known translation projects for the Sails documentation are listed in the README sails-docs.
In addition to the official code repositories that are supported by the Sails.js core team, there are countless other plugins created by members of the Sails.js community.
There are at least 200 community hooks for Sails.js available on NPM.
Need to customize your build? Want automatically-generated spritesheets? Source maps? Sails.js uses Grunt for its asset pipeline, which means it supports any Grunt plugin. out of the box. There are thousands of Grunt plugins available on NPM.
Don't like Grunt? Want to use WebPack or Gulp instead? Prefer your generated backend files to be written in CoffeeScript? There are at least 100 community generators for Sails.js available on NPM.
<!-- Looking for the list that used to be here? See https://github.com/balderdashy/sails-docs/blob/323477613b6b9ab0cfd7dfb38e53cdff6f46f5d8/concepts/extending-sails/Generators/generatorList.md -->Learn how to use community generators, and how to build your own.
Is your database not supported by one of the core adapters? Good news! There are many different community database adapters for Sails.js and Waterline available on NPM.
Need to upload files to a cloud file store like S3, GridFS, or Azure Cloud Files? Check out the community filesystem adapters for Sails.js and Skipper available on NPM.
Learn how to wire up one or more custom filesystem adapters for your application.
Need to process payments with Stripe? Fetch video metadata from YouTube? Process user email data via Google APIs? Choose from hundreds of community machinepacks for Sails.js/Node available on NPM.
Learn how to install and use machinepacks in your controller actions and helpers.
Want to work with your database at a low level? Need to get extra performance out of your database queries? Dynamic database connections?
Is EJS bumming you out? Prefer to use a different templating language like pug (/jade), handlebars, or dust? Sails.js supports almost any Consolidate/Express-compatible view engine-- meaning you can use just about any imaginable markup language for your Sails.js views. Check out the community view engines for Sails.js and Express available on NPM.
The recommended production session store for Sails.js is Redis... but we realize that, for some apps, that isn't an option. Fortunately, Sails.js supports almost any Connect/Express-compatible session store-- meaning you can store your sessions almost anywhere, whether that's Mongo, on the local filesystem, or even in a relational database. Check out the community session stores for Sails.js, Express, and Connect available on NPM.
Learn how to install and configure a custom session store in your Sails app.
Need to connect to Sails from a native iPhone or Android app?
| Platform | Repo | Build Status (edge) |
|---|---|---|
| iOS | sails.ios | |
| Objective C | sails.io.objective-c | N/A |
| Android | Sails Messenger | N/A |
| React Native | React Native example | N/A |
| Cordova | Phonegap tips | N/A |
| Package | Latest Stable Release | Purpose |
|---|---|---|
| sails-migrations | Manual migration tool for Sails, built on Knex. | |
| sails-mysql-transactions | Augmented database adapter for mySQL with transaction and replication support. | |
| sails-inverse-model | Generate Sails/Waterline model definitions from a pre-existing database. |
For easier maintainence, they were pulled into sails-generate.
You can read about naming conventions for plugins and core modules here. Covers NPM dist tags, git tags, and version strings, as well as recommendations for hotfix branches.