Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marabesi/mqtt-skeleton

Easy way to get start using MQTT (nodejs)
https://github.com/marabesi/mqtt-skeleton

broker dotenv javascript mqtt nodejs queue skeleton

Last synced: about 1 month ago
JSON representation

Easy way to get start using MQTT (nodejs)

Host: GitHub
URL: https://github.com/marabesi/mqtt-skeleton
Owner: marabesi
Created: 2018-02-06T17:06:56.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2022-12-10T16:14:31.000Z (about 2 years ago)
Last Synced: 2024-10-28T17:17:04.871Z (3 months ago)
Topics: broker, dotenv, javascript, mqtt, nodejs, queue, skeleton
Language: JavaScript
Size: 631 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

![NODE + MQTT](https://preview.ibb.co/diijQn/node_mqtt.png)

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

# mqtt-skeleton

Easy way to get start using MQTT (nodejs). The main idea of the repository is to give a scafolding of everything you might need while using MQTT and nodejs.

The project has the following dependencies so far:

* [dotenv](https://www.npmjs.com/package/dotenv)
* [mqtt](https://www.npmjs.com/package/mqtt)
* [concurrently](https://www.npmjs.com/package/concurrently)

Development dependencies:

* [nodemon](https://www.npmjs.com/package/nodemon)

## Setting up

1. Clone this repository

``
git clone https://github.com/marabesi/mqtt-skeleton/ && cd mqtt-skeleton
``

2. Install the dependencies with [NPM](http://npmjs.com)

``
npm install
``

3. Configure the environment variables

Make sure to have a MQTT protocol up and running (can be a private server, or cloud like [cloudmqtt.com](https://www.cloudmqtt.com/)). With that in mind you should have at least the following credentials: host, user, password and port.

The next step is create a `.env` file in the root of your cloned folder, and replace the values shown below with the given by your MQTT provider.

```env
MQTT_SERVER=localhost
MQTT_USER=myuser
MQTT_PASSWORD=mypassword
MQTT_PORT=myport
MQTT_TOPIC=/mytopic
```

4. Decide which environment you would like to run, development (with nodemon) or directly with node.
The following starts the application using nodejs comman, behind the scenes npm is running `node ./index.js`.

```
npm run start
```

The second option is to use nodemon, which avois killing the script and starting it again everytime you
change something in the code.

```
npm run nodemon
```

## Hivemq Dashboard

Often we want to see what is going on in our MQTT server, know which messages are being sent,
who is connected to it and sometimes push new messages to the queue without coding a script
to it. For that reason, this project uses the Hivemq Dashboard, an open source project
that allows us to see staticts about the MQTT server.

To access the dashboard, after start running the server access the 8080 port.

```
open http://localhost:8080
```