https://github.com/conversejs/generator-conversejs
A Converse.js plugin generator
https://github.com/conversejs/generator-conversejs
yeoman-generator
Last synced: 5 months ago
JSON representation
A Converse.js plugin generator
- Host: GitHub
- URL: https://github.com/conversejs/generator-conversejs
- Owner: conversejs
- License: bsd-3-clause
- Created: 2017-09-02T19:50:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T02:26:39.000Z (over 3 years ago)
- Last Synced: 2024-12-29T15:47:06.151Z (over 1 year ago)
- Topics: yeoman-generator
- Language: JavaScript
- Size: 439 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Converse.js plugin generator
This is a [Yeoman](http://yeoman.io/) generator for creating [Converse.js](https://conversejs.org) plugins.
## Creating a plugin
Firstly, make sure you have Yeoman installed:
npm install -g yo generator-conversejs
Then, to create a new plugin, run the following:
$ yo conversejs converse-pluginname
Where `pluginname` should be the name of your plugin.
### Demo your plugin
Once you've generated your plugin, you can navigate into its folder, and then
run `npm install && npm start` to install its dependencies and to start a
webserver.
Then you can open `http://localhost:8080` in your browser to demo your newly
generated plugin.
## Further reading
Converse.js uses [pluggable.js](https://jcbrand.github.io/pluggable.js/) to
provide its plugin architecture.
For more info on how plugins work and how to write them, you can read
Converse.js's [documentation on how to write a plugin](https://conversejs.org/docs/html/plugin_development.html)
as well as the [pluggable.js documentation](https://conversejs.org/docs/html/plugin_development.html).
## Hacking on this generator
To hack and develop `generator-conversejs` or to use the generator directly from the latest source-code,
do the following:
npm install -g yo # Make sure yo is installed globally
Check out this repository.
git clone git@github.com:jcbrand/generator-conversejs.git
Within the checked out repository, issue the following commands:
$ npm install
$ npm link
Now you're ready to create your plugin:
$ yo conversejs converse-pluginname