@posthog/hello-world-plugin
v0.0.7
Published
[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
Downloads
11
Readme
PostHog Plugin: Hello World Starter Kit
This is a basic exemplary PostHog plugin. It adds property "greeting"
to every event, with a configurable value (default: "Hello world!"
).
Feel free to use it as a base for your own plugins!
How to develop
All of the plugin's code is located in the index.js
file, which is JavaScript ran inside of PostHog.
To get yourself up to speed with this environment, we sincerely recommend checking out our [Plugins overview in PostHog Docs](the Plugins Overview.
For a crash course, read our plugin building tutorial in PostHog Docs.
How to test
To test the plugin, you'll need to install a few npm
dependencies already specified in package.json
:
npm install
This will get you the testing library Jest and some our test helpers. Then to run tests it's just:
npm test
How to install
- Open PostHog.
- Open the Plugins page from the sidebar.
- Head to the Advanced tab.
- "Install from GitHub, GitLab or npm" using this repository's URL.
Questions?
Join our Slack community.
We're here to help you with anything PostHog!