Initialization
The first steps in development are initializing the plugin, and defining the type of plugin through templates. At the bottom of the page, we will begin to follow a simple example
Make sure you run
npm install in the /plugins directory in HollaEx Kit before any other steps.To start the development process, you need to initialize the plugin template. This template includes the folder structure and some pre-defined configurations to facilitate the development experience.
Below is a list of available plugin templates:
Type | Template Details |
|---|---|
page | adds a new page with customizable access from the side and top menus |
verification-tab | adds a new verification tab to the user verification page |
fiat-wallet | adds a deposit and withdraw page for a fiat currency |
kyc | adds KYC tab to the user verification page |
bank | adds bank verification tab to the user verification page |
raw | adds a template without initial meta object values |
onramp | adds an on-ramp section for the fiat controls feature |
app | adds an app view to the apps section tables |
server | adds a template without any view (Server-only) |
- 1.Once you decide on the type of plugin, go to
/pluginsand runnpm run add:plugin --plugin=<PLUGIN_NAME> --type=<PLUGIN_TYPE>to initialize the plugin template.
npm run add:plugin --plugin=<PLUGIN_NAME> --type=<PLUGIN_TYPE>
This will create a folder named the plugin's name in the
/plugins folder.In order to develop a plugin, we need to understand all the main components of a plugin. These main components of any HollaEx plugin will be looked at in the next sections.
- 1.
- 2.
- 3.
- 4.Plugin JSON
Last modified 5mo ago