This is the package you include if you are writing a server-assist server-side app/module.
SeverAssist is a technology that aims to allow client-side developers (mostly mobile) to easily leverage server-side technologies. For example, for a client-side app to easily store things on S3.
If, however, you are writing a server-side technology, and want it to play well with other ServerAssist server-side things, you should use this module to assist you.
Projects and Apps
This is a big, feature-rich package, pretty much like you would expect with a name like Project.
A project has a name, but the projectId is the thing that is key. It is the projects namespace
within the system. So, for the mythical
project project, it would have a projectId of
example. As such, it would get the URL space:
The Project can allocate the URL path however it wants, but should follow the conventions. The code should not care about the subdomains -- ServerAssist will manage those.
name, a project's DB entries consist of:
Apps are really what most developers know as micro-services. They are (usually) small services that are available to other server-side entities, as well as client-side. Apps belong to a project, and thus are always mounted within the project's URL space:
It is the app's perogative to allocate the URL space below its own. An app work correctly irrespectively of where it gets mounted, but it will be informed.
An apps DB entries are:
server-assist-server/webtier/webtier.js manages the instances that act as the webtier.
server-assist-server/hq/hq.js is the top-level controller for the cluster.
This is an NPM package you require in order to help you hook your micro-service into the server-side of ServerAssist. It is also used by the server-assist-server modules.
Attribute man is a server-side app for the server-assist project, itself. It is a telemetry collector app. You send it unstructured JSON data, and attr-man stores it in S3 for you.
When on a local workstation, the system automatically inserts a service for development
of SPAs on the local machine. The service is at localhost:3000, and the FQDN is
It is the webtier.js module of server-assist-server that does this favor.