Contributing to plugins

absurdsmash

I would like to contribute or write my own plugins; is there any guide for this available apart from the official nodebb documentation?

Example things Im looking for are; how to setup dev environment, pull code, test in seperate nodebb.

jimmyc2018

Writing Plugins for NodeBB

PitaJ

I'd suggest checking out nodebb plugin quickstart

julian

Seconding quickstart plugin -- that will get you going as soon as possible

imavlr

Is the quickstart plugin outdated?
I've been scouring the web looking for resources on plugin-writing, the docs really need to get updated, most of the things I find are from 2015, the docs need a serious overhaul.

I've downloaded and activated the quickstart plugin and even rebuilt nodebb after doing so, but nothing happens, the admin panel is not accessible and it doesn't print anything into my console.
I'm running v1.7.4.

julian

@imavlr The quickstart plugin is not outdated, I use it every time I need to make a plugin.

Why would it show anything when you activate it? It's not meant to be used as a standalone plugin, you have to fork it and customise it with the names and pages.

imavlr

@julian because there's a line that prints to the console by default, it doesn't for me.
https://github.com/NodeBB/nodebb-plugin-quickstart/blob/master/static/lib/main.js

Also, the admin panel doesn't show up after installing the plugin as is, even though there does appear to be an admin panel component with it (haven't checked that part of the code as I won't need it for my plugin).

PitaJ

How did you install the plugin? What version of npm are you using? Are you positive you activated the plugin after installation? Are there any warnings or otherwise in the NodeBB log? Did you run ./nodebb build?

imavlr

Ah, I've figured out the problem, it was a silly mistake. I had forgotten to rename the folder to match the plugin name. Thanks for verifying the quickstart plugin works.