Go to file
Julian Lam 842dd721ad tweaking client-side l ib 2017-01-05 13:38:49 -05:00
lib updated structure, added MIT license, moved ACP js to its own separate file 2015-03-13 14:05:43 -04:00
static tweaking client-side l ib 2017-01-05 13:38:49 -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
LICENSE changed license year 2016-07-13 13:25:25 -04:00
README.md I fail at markdown 2015-09-17 02:04:12 -04:00
library.js updated structure, added MIT license, moved ACP js to its own separate file 2015-03-13 14:05:43 -04:00
package.json acpScripts fix for v1.0.0 2016-01-19 15:02:38 -05:00
plugin.json remove style.less from my fork 2017-01-05 11:47:48 -05: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.

Once you're done don't forget to publish it on NPM, and make a thread about it here.

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!