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-04 04:41:05 +08:00
Code Issues Projects Packages Wiki Activity Actions
A starter kit for quickly creating NodeBB plugins.
141 commits 6 branches 5 tags 2.2 MiB
Find a file
Exact
Barış Soner Uşaklı bc3f71b436 0.4.2
2021-10-07 12:41:37 -04:00
lib fix: linting a bunch of files 2019-01-26 11:47:34 -05:00
static fix: closes #75 2021-10-07 12:41:18 -04:00
test docs: updated test file comments to include direction re: test_plugins config 2021-09-21 10:19:38 -04:00
.eslintrc feat: use eslint-config-nodebb 2021-08-08 15:37:25 -04: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 chore: update eslint and commitlint configs to match core 2020-12-16 13:54:56 -05:00
library.js lint: missing semicolon 2021-09-03 14:58:20 -04:00
LICENSE changed license year 2016-07-13 13:25:14 -04:00
package.json 0.4.2 2021-10-07 12:41:37 -04:00
plugin.json feat: #71, add a new page sample 2021-09-03 12:49:36 -04:00
README.md fix: #7, removed line that linked to unrelated page 2018-12-13 11:53:40 -05:00
renovate.json Add renovate.json 2020-12-16 13:53:10 -05:00
yarn.lock chore(deps): update dependency lint-staged to v11.2.0 2021-10-04 07:46:46 -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!