Welcome to the plugin development guide! Whether you're building a custom plugin for our platform or extending existing functionality, this guide will walk you through the essentials.
Getting Started 🚀
Set Up Your Environment
- Install the required dependencies: Visit our setup guide for detailed steps.
- Use a code editor like VS Code or Sublime Text.
Create a New Plugin Project
- Initialize a new directory for your plugin.
- Run
npm init
oryarn init
to create apackage.json
file.
Key Concepts 📌
- Plugin Structure: A typical plugin includes
manifest.json
,index.js
, andassets/
. - API Integration: Leverage our core API to interact with the platform.
- Event Listeners: Hook into events like
onLoad
oronRequest
.
Best Practices ✅
- Keep your code modular and reusable.
- Document your plugin's features clearly.
- Test thoroughly using our testing framework.