[nodebb-plugin-quickstart] Plugin starter kit


  • Admin

    Fork it on GitHub

    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 the documentation.

    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!



  • imgres.jpg



  • Notice that client-side script added in plugin.json, and have not a scripts.get hook. I actived the plugin and found the client-side log "nodebb-plugin-quickstart: loaded" not print untill refreash the page.



  • @niro said:

    Notice that client-side script added in plugin.json, and have not a scripts.get hook. I actived the plugin and found the client-side log "nodebb-plugin-quickstart: loaded" not print untill refreash the page.

    Take back the post, it's ok, some wrong with my code.


  • Admin

    @niro That's right... I encourage plugin writers to use the scripts property in plugin.json over the scripts.get hook if at all possible, as the script is then minified on production.


 

Suggested Topics

  • 2
  • 7
  • 27
  • 5
  • 8
| |