mirror of
https://hk.gh-proxy.com/https://github.com/NodeBB/nodebb-plugin-quickstart.git
synced 2025-10-04 04:41:05 +08:00
A starter kit for quickly creating NodeBB plugins.
| languages | ||
| lib | ||
| public/lib | ||
| scss | ||
| static | ||
| templates | ||
| test | ||
| .gitattributes | ||
| .gitignore | ||
| .npmignore | ||
| commitlint.config.js | ||
| eslint.config.mjs | ||
| library.js | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| plugin.json | ||
| README.md | ||
| renovate.json | ||
| yarn.lock | ||
Quickstart Plugin for NodeBB
A starter kit for quickly creating NodeBB plugins. Comes with a pre-setup SCSS file, server side JS script with an static: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, and for more information about creating plugins please visit our documentation portal.
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 public/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!
