Permalink
Find file
240 lines (139 sloc) 23.4 KB

Modules

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.

Sails core

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.

Framework and ORM

For more information on the available releases of the Sails framework as a whole, check out the contribution guide.

Package Latest Stable Release Build Status (edge)
Sails.js logo (small) NPM version Build Status
waterline NPM version Build Status

Core hooks

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
grunt sails-hook-grunt NPM version Build Status Governs the built-in asset pipeline in Sails.
orm sails-hook-orm NPM version Build Status Implements support for Waterline ORM in Sails.
sockets sails-hook-sockets NPM version Build Status Implements Socket.io support in Sails.

These are not all the core hooks in Sails. There are other core hooks built in to the sails package itself (see lib/hooks/). These other, built-in hooks can still be disabled or overridden using the same configuration.

Core socket client SDKs

Platform Package Latest Stable Release Build Status (edge)
Browser sails.io.js-dist NPM version Build Status
Node.js sails.io.js NPM version Build Status

Core database adapters

Package Latest Stable Release Build Status (edge) Platform
sails-disk NPM version Build Status Local disk (.tmp/)
sails-mysql NPM version Build Status MySQL
sails-postgresql NPM version Build Status PostgreSQL
sails-mongo NPM version Build Status MongoDB
sails-redis NPM version Build Status Redis

Core filesystem adapters

Package Latest Stable Release Build Status (edge) Platform
skipper-disk NPM version Build Status Local disk (.tmp/uploads/)

Core generators

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.

Core framework utilities

Package Latest Stable Release Build Status (edge)
skipper NPM version Build Status
machine NPM version Build Status
machine-as-action NPM version Build Status
machine-as-script NPM version Build Status
captains-log NPM version Build Status
anchor NPM version Build Status
sails-generate NPM version Build Status
waterline-criteria NPM version Build Status
waterline-schema NPM version Build Status
waterline-utils NPM version Build Status
include-all NPM version Build Status
reportback NPM version n/a
switchback NPM version Build Status
rttc NPM version Build Status
@sailshq/lodash npm version n/a

Official Documentation

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.

Community projects

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.

Hooks

There are at least 200 community hooks for Sails.js available on NPM.

Learn about custom hooks in Sails.

Asset pipeline

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.

Learn how to customize your app's asset pipeline.

Generators

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.

Learn how to use community generators, and how to build your own.

Database adapters

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.

Learn how to install and configure community adapters.

Filesystem adapters

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.

3rd party integrations

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.

Database drivers

Want to work with your database at a low level? Need to get extra performance out of your database queries? Dynamic database connections?

Learn about Waterline drivers.

View engines

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.

Learn how to set up a custom view engine for your app.

Session stores

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 fileystem, 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.

Socket client SDKs & examples

Platform Repo Build Status (edge)
iOS sails.ios CI Status
Android Sails Messenger N/A
Angular angularSails Build Status
Objective C sails.io.objective-c N/A
Backbone backbone-to-sails N/A

Misc. projects

Package Latest Stable Release Purpose
sails-stdlib NPM version Evolving library of well-tested, well-documented, and officially supported modules for the most common everyday tasks in apps (e.g. password encryption, etc.)
stdlib NPM version A lighter build of sails-stdlib, designed for use outside of the environment of a Sails app (e.g. when building lower-level Node.js modules like machinepacks)
sails-migrations NPM version Manual migration tool for Sails, built on Knex.
sails-mysql-transactions NPM version Augmented database adapter for mySQL with transaction and replication support.
sails-inverse-model Generate Sails/Waterline model definitions from a pre-existing database.

FAQ

What happened to the core generators?

For easier maintainence, they were pulled into sails-generate.