NodeBB/nodebb-plugin-quickstart
2
0
Fork 0
mirror of https://hk.gh-proxy.com/https://github.com/NodeBB/nodebb-plugin-quickstart.git synced 2025-10-03 04:30:57 +08:00
Code Issues Projects Packages Wiki Activity Actions
A starter kit for quickly creating NodeBB plugins.
42 commits 6 branches 5 tags 2.2 MiB
Find a file
Julian Lam 273cd7b447 0.2.4
2019-07-15 11:18:45 -04:00
lib fix: linting a bunch of files 2019-01-26 11:47:34 -05:00
static fix: linting a bunch of files 2019-01-26 11:47:34 -05:00
.eslintrc feat: add eslint, husky, lint-staged, commitlint 2019-01-26 11:45:12 -05:00
.gitattributes init 2014-06-04 16:08:24 -04:00
.gitignore init 2014-06-04 16:08:24 -04:00
.npmignore init 2014-06-04 16:08:24 -04:00
commitlint.config.js feat: add eslint, husky, lint-staged, commitlint 2019-01-26 11:45:12 -05:00
library.js fix: linting a bunch of files 2019-01-26 11:47:34 -05:00
LICENSE changed license year 2016-07-13 13:25:14 -04:00
package.json 0.2.4 2019-07-15 11:18:45 -04:00
plugin.json acpScripts fix for v1.0.0 2016-01-19 15:02:30 -05:00
README.md fix: #7, removed line that linked to unrelated page 2018-12-13 11:53:40 -05:00
yarn.lock fix: bump dependencies 2019-07-15 11:18:45 -04:00

README.md

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, 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 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!