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.
378 commits 6 branches 5 tags 2.2 MiB
Find a file
renovate[bot] b6224b9425 chore(deps): update dependency lint-staged to v15.2.7
2024-06-12 15:23:00 -04:00
lib Merge branch 'master' of https://github.com/NodeBB/nodebb-plugin-quickstart 2023-06-12 11:30:55 -04:00
static refactor: quickstart acp client-side js to ES Module 2023-08-04 16:21:10 -04:00
test feat: add eslintrc for test/ 2023-01-20 11:55:52 -05:00
.eslintrc refactor: quickstart acp client-side js to ES Module 2023-08-04 16:21:10 -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 Merge branch 'master' of https://github.com/NodeBB/nodebb-plugin-quickstart 2023-06-12 11:30:55 -04:00
LICENSE changed license year 2016-07-13 13:25:14 -04:00
package.json chore(deps): update dependency lint-staged to v15.2.7 2024-06-12 15:23:00 -04:00
plugin.json update for bs5 2022-09-19 10:15:22 -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 v15.2.7 2024-06-12 15:23:00 -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!