https://github.com/nodebb/nodebb-plugin-quickstart
A starter kit for quickly creating NodeBB plugins.
https://github.com/nodebb/nodebb-plugin-quickstart
Last synced: 6 months ago
JSON representation
A starter kit for quickly creating NodeBB plugins.
- Host: GitHub
- URL: https://github.com/nodebb/nodebb-plugin-quickstart
- Owner: NodeBB
- License: mit
- Created: 2014-06-04T20:08:41.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T11:35:50.000Z (about 1 year ago)
- Last Synced: 2024-04-14T11:52:03.636Z (about 1 year ago)
- Language: JavaScript
- Size: 885 KB
- Stars: 58
- Watchers: 13
- Forks: 92
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quickstart Plugin for NodeBB
A starter kit for quickly creating NodeBB plugins. Comes with a pre-setup LESS file, server side JS script with an `action:app.load` hook, and a client-side script. Most plugins need at least one of the above, so this ought to save you some time. For a full list of hooks have a look at our [wiki page](https://github.com/NodeBB/NodeBB/wiki/Hooks), and for more information about creating plugins please visit our [documentation portal](https://docs.nodebb.org/).
Fork this or copy it, and using your favourite text editor find and replace all instances of `nodebb-plugin-quickstart` with `nodebb-plugin-your-plugins-name`. Change the author's name in the LICENSE and package.json files.
## Hello World
Really simple, just edit `static/lib/main.js` and paste in `console.log('hello world');`, and that's it!
## Installation
npm install nodebb-plugin-quickstart
## Screenshots
Don't forget to add screenshots!