Welcome to the Plugin Development Documentation! Here you can find all the information you need to develop plugins for our platform.
Getting Started
Before you start developing a plugin, make sure you have the following prerequisites:
- Basic knowledge of programming
- Familiarity with our platform's API
- A development environment set up
Development Environment
To develop plugins, you will need a development environment. You can find more information about setting up your development environment in the Developer Guide.
Plugin Structure
A plugin typically consists of the following files and directories:
plugin.json
: Describes the plugin, including its name, version, and dependencies.src/
: Contains the source code for the plugin.resources/
: Contains any static files required by the plugin, such as images or CSS files.
Plugin Development
Here are some key points to consider when developing a plugin:
- Use the API: Make sure to use our platform's API to interact with the system.
- Follow the guidelines: Follow our development guidelines to ensure your plugin is compatible and secure.
- Test your plugin: Test your plugin thoroughly before submitting it for review.
Example
Here is a simple example of a plugin's plugin.json
file:
{
"name": "ExamplePlugin",
"version": "1.0.0",
"description": "An example plugin for our platform",
"author": "Your Name",
"dependencies": []
}
Resources
For more information, please refer to the following resources:
Plugin Development