repository·master·Indexed 12 days ago
https://github.com/balderdashy/sailsAn enterprise-grade MVC web framework for Node.js designed for building complex, data-driven, and real-time applications. Based on Express and Socket.io, version 1.5.18 provides native support for async/await, WebSockets, and a structured architecture similar to Ruby on Rails.
Sails apps come bundled with Waterline, an Object-Relational Mapper (ORM) implemented via the sails-hook-orm dependency. Waterline allows you to interact with your database using JavaScript models instead of writing raw SQL.
For fundamental usage patterns, refer to the Concepts > Models & ORM documentation.
Sails uses socket.io as its underlying engine for realtime communication. While every Sails application has a raw Socket.IO instance available via sails.io, most realtime functionality is wrapped by the sails.sockets method to provide a more convenient and safer API for developers.
Key areas of WebSocket usage in Sails include:
sails.io.js client library.sails.sockets API.Resourceful PubSub to broadcast changes in Sails models to connected clients.Sails.js can be deployed to almost any Node.js compatible hosting provider. The deployment process is generally identical to deploying any other Node.js application.
config/env/production.js file.sails.io.js library is a lightweight JavaScript wrapper for the Socket.IO client designed for Sails applications. It provides an Ajax-like interface (.get(), .post(), .put(), and .delete()) that allows you to communicate with your Sails backend using WebSockets while reusing your existing HTTP routes. When you call io.socket.post('/user'), Sails routes it exactly like an HTTP POST request to that route.In Sails, database adapters expose interfaces that act as a contract for implementing specific functionality. This ensures consistent usage patterns across different models and databases.
Adapters are designed for services that fit a CRUD (Create, Read, Update, Delete) mold. If you are integrating a service with an RPC-style interface (e.g., sending an email or reading a remote sensor with one-off methods), you should use a machinepack instead of a Waterline adapter.
Resourceful PubSub (RPS) is a high-level, data-centric interface for managing real-time client-server communication in Sails. Instead of manually managing socket rooms and event names, RPS automatically equips every model with methods to broadcast notifications and subscribe sockets to specific database records.
Key Benefits:
find or findOne blueprints via a socket request automatically subscribes the requesting socket to those records.sails.sockets.* methods, handling the complexity of room naming and event identity behind the scenes.A one way association (also known as a "Belongs To" association) occurs when one model is associated with another, but the relationship is not reciprocal in the model definitions.
In this setup:
User) and use .populate() to retrieve the associated model (e.g., Pet).Pet) and use .populate() to retrieve the associating model (e.g., User), because the Pet model has no knowledge of the User.Because the association is only defined on one side, the associated model (the Pet) has no restrictions on how many models of the associating type (User) can point to it.
In Sails, middleware refers to code that runs in the middle of the request/response stack. Depending on your specific goal, you can implement different types of middleware:
routes feature: Runs before one or more route handlers.Note: The HTTP middleware stack is only used for "true" HTTP requests; it is ignored for virtual requests (e.g., requests from a live Socket.io connection).
The sails-hook-blueprints is a core hook in the Sails.js framework that implements support for the Blueprint API. It automates the creation of RESTful routes by:
sails.modules into the hook's middleware.route:typeUnknown event on the sails instance to interpret route syntax and bind the appropriate middleware during the Router loading phase.Because it is a core hook, it is enabled by default in Sails applications.
The Sails asset pipeline uses Grunt tasks to automate frontend workflows. It provides a set of conventional defaults that can be fully customized to fit your project's needs.
Key capabilities included in the default configuration:
.tmp/public/ directory.