Documentation

First plugin

Generate a VitNode plugin in a few minutes, open its page at /site-notes, and continue with the lessons that add an API, a database table, permissions and an AdminCP screen.

This is the short version: generate a plugin and see its page. The Learn lessons build the same site-notes plugin into a real feature.

Before you begin

  • A VitNode app created with Turborepo turned on, running locally. Setup walks through it.

Generate the plugin

From the workspace root:

Generate the plugin
bun create vitnode-app@canary site-notes --plugin

The generator creates plugins/site-notes and registers it in your app's VitNode configs, so there is nothing to enable by hand.

Run it

Start the app
bun run dev

Check the result

Open http://localhost:3000/site-notes. The page comes from plugins/site-notes/src/pages/home-page.tsx, and http://localhost:3000/api/site-notes/hello answers from the plugin's API.

The generated site-notes plugin page at /site-notes in a VitNode app