Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redclawtech/rebar3_template_vernemq
A rebar3 template for VerneMQ(https://vernemq.com) plugins.
https://github.com/redclawtech/rebar3_template_vernemq
erlang mqtt rebar3 rebar3-template vernemq vernemq-plugins
Last synced: 2 months ago
JSON representation
A rebar3 template for VerneMQ(https://vernemq.com) plugins.
- Host: GitHub
- URL: https://github.com/redclawtech/rebar3_template_vernemq
- Owner: redclawtech
- License: apache-2.0
- Created: 2020-02-02T05:48:25.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-30T20:27:37.000Z (over 1 year ago)
- Last Synced: 2024-08-01T23:40:29.563Z (5 months ago)
- Topics: erlang, mqtt, rebar3, rebar3-template, vernemq, vernemq-plugins
- Language: Erlang
- Homepage:
- Size: 22.5 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rebar3_template_vernemq
This repo provides a [rebar3](http://rebar3.org) template for easier creation of [VerneMQ](https://vernemq.com) plugins.
## Setup
To install, simply clone to `~/.config/rebar3/templates`:
```
mkdir -p ~/.config/rebar3/templates
git clone https://github.com/redclawtech/rebar3_template_vernemq.git ~/.config/rebar3/templates/rebar3_template_vernemq
```
## Usage
```console
$ rebar3 new vernemq_plugin name=vmq_coolplugin
$ cd vmq_coolplugin
```
### Options (aka. variables)
To see a full description of all the options available, you can run `rebar3 new help vernemq_plugin`:
```console
$ rebar3 new help vernemq_plugin
vernemq_plugin:
custom template (~/.config/rebar3/templates/rebar3_template_vernemq/vernemq_plugin.template)
Description: Generates a VerneMQ Plugin
Variables:
name="my_plugin" (Name of the VerneMQ Plugin)
desc="A VerneMQ plugin" (Short description of the VerneMQ plugin)
license="Apache 2.0" (License to use for this Plugin)
no_mqtt_three=false (Do not make the plugin support MQTT 3.1 hooks)
no_mqtt_five=false (Do not make the plugin support MQTT 5 hooks)
date="2020-03-07"
datetime="2020-03-07T02:05:05+00:00"
author_name="Dairon Medina Caro"
author_email="[email protected]"
copyright_year="2020"
apps_dir="apps" (Directory where applications will be created if needed)
```
## License
Copyright (c) 2020 [RedClaw Technologies](http://www.redclawtech.com)
This work is free. You can redistribute it and/or modify it under the
terms of the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.