The Mini Loca Pub Sub (mlps) is used as publish/subscribe service in a local network.

You can install the Mini Loca Pub Sub using npm (the Node Package Manager). Note that you will need to install Node.js and npm. Installing Node.js should install npm as well.

To download and install the Mini Loca Pub Sub run the following command:

npm install -g @nsftx/local-pub-sub

This will provide you with the globally accessible mlps command.

The command mlps will start service.

The Mini Loca Pub Sub can also be used programmatically as a standard Node module.

That translates to the following in Node:

const mlps = require('@nsftx/local-pub-sub');
mlps.start();

End user documentation can be found here.

# Clone your Github repository:
git clone [email protected]:nsftx/local-pub-sub.git

# Go to the Mini Local Pub Sub directory:
cd local-pub-sub

# Install JavaScript dependencies:
npm i install

# Run app and watch for changes:
npm run dev

We use SemVer for versioning. For the versions available, see the releases on this repository.

In order to release next version of the library pull request is required. Use following steps for release.

• Merge approved pull requests that should be in next version to master
• Create version-$nextVersion branch from master
• run npm version -$versionType
• Push branch & tag to remote
• After pull request is merged, create a new Release
• GitHub will trigger action (.github/workflows/release.yml) and it will publish package