Skip to content

Latest commit

 

History

History
166 lines (115 loc) · 14.3 KB

MODULES.md

File metadata and controls

166 lines (115 loc) · 14.3 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.

Core modules

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

Repo Build Status (edge) Latest Stable Version
Sails.js logo (small) Build Status NPM version
waterline Build Status NPM version
anchor Build Status NPM version
waterline-criteria Build Status NPM version
waterline-errors Build Status NPM version
waterline-schema Build Status NPM version
sails-generate Build Status NPM version
sails-build-dictionary N/A NPM version
captains-log Build Status NPM version
sails-stringfile N/A NPM version

Utilities

Repo Latest Stable Version
sails-util (will be deprecated) NPM version
include-all NPM version
reportback NPM version
node-switchback NPM version
merge-defaults NPM version
enpeem NPM version
merge-context NPM version
fixture-stdout NPM version

Officially-supported generators

Repo Latest Stable Version
sails-generate-generator NPM version
sails-generate-new NPM version
sails-generate-controller NPM version
sails-generate-frontend NPM version
sails-generate-backend
sails-generate-views
sails-generate-adapter
sails-generate-model
sails-generate-api
sails-generate-test
sails-generate-hook

Officially-supported adapters

Repo Build Status (edge) Latest Stable Version Platform
Local Disk Build Status NPM version Local disk (.tmp)
MySQL Build Status NPM version MySQL
PostgreSQL Build Status NPM version PostgreSQL
Mongo Build Status NPM version MongoDB
Redis Build Status NPM version Redis

Officially-supported hooks

Hook Repo Build Status (edge) Purpose
orm sails-hook-orm Build Status Implements support for Waterline ORM in Sails.
sockets sails-hook-sockets Build Status Implements Socket.io support in Sails.

The code for other hooks not listed above without specific repos is currently contained in sub-folders within Sails core. See lib/hooks/

Socket Client SDKs

Platform Repo Build Status (edge)
Browser sails.io.js Build Status
Node.js sails.io.js Build Status

Documentation

Repo Purpose
sails-docs Raw content for reference, conceptual, anatomical, and other documentation on the Sails website (in Markdown).
www.sailsjs.org The Sails app that powers sailsjs.org. HTML content is automatically compiled from sails-docs.

Community

Adapters

Repo Build Status (edge) Latest Stable Version Platform
sails-orientdb Build Status npm version OrientDB
sails-rest REST
sails-oracle Oracle
sails-mssql MSSQL (for sails@<=0.9.x)
sails-sqlserver SQL Server
sails-neo4j Neo4j
sails-sqlite3 SQLite3
sails-dynamodb DynamoDB
sails-elasticsearch Elasticsearch
sails-couchdb CouchDB
sails-couchbase Couchbase
sails-odata OData
sails-db2 DB2
sails-rethinkdb RethinkDB
sails-azuretables Windows Azure Tables
sails-riak Riak
sails-nedb NeDB
sails-parse Parse
sails-tingo TingoDB

Generators

Note that this section will be migrating to https://github.com/balderdashy/sails-docs/concepts/extending-sails/Generators/generatorList.md for consistency.

Repo Build Status (edge)
sails-generate-auth
sails-generate-bower
sails-generate-new-gulp
sails-generate-frontend-gulp
sails-generate-backend-gulp
sails-generate-gulpfile
sails-generate-bower-gulp
sails-generate-angular-gulp
sails-generate-ember-blueprints

Socket Client SDKs

Repo Build Status (edge)
angularSails Build Status
sails.io.objective-c NEEDS_TRAVIS_SETUP
backbone-to-sails Build Status

Misc. Projects

Repo
sails-migrations
sails-mysql-transactions

FAQ

If you have an unanswered question that isn't covered here, and that you feel would add value for the community, please feel free to send a PR adding it to this section.