CNS Broker

Table of Contents

• About
• Installing
• Usage
• Maintainers
• License
• Copyright Notice

About

This project contains a Node.js application providing an mqtt service used to connect node contexts together using connection profiles. The application works on any POSIX-compliant shell (sh, dash, ksh, zsh, bash), in particular on these platforms: unix, linux, macOS, and Windows WSL.

Installing

To install or update the application, you should fetch the latest version from this Git repository. To do that, you may either download and unpack the repo zip file, or clone the repo using:

git clone https://github.com/cnscp/cns-broker.git

Either method should get you a copy of the latest version. It is recommended (but not compulsory) to place the repo in the ~/cns-broker project directory. Go to the project directory and install Node.js dependancies with:

npm install

Your application should now be ready to rock.

Usage

Once installed, run the application with:

npm run start

To shut down the application, hit ctrl-c.

Maintainers

This project contains two environments, one for Staging (development) and one for Production. It is recommended to push changes to Staging, test those changes, then deploy them to Production.

Pushing to Staging

Push changes to Staging environment with:

npm run push

The version patch number in package.json will automatically be incremented.

Deploying to Production

Deploy Staging changes to Production environment with:

npm run deploy

The version minor number in package.json will automatically be incremented and the patch number reset.

Digital Ocean

License

See LICENSE.md.

Copyright Notice

See COPYRIGHT.md.