Plugins

TradeJourney has a plugin system that allows you to extend its features without modifying the application's source code. Plugins are developed in the plugins-dev/ folder and compiled into .zip format to be imported into the application. This is very convenient for adding custom features while keeping a clean codebase.

Prerequisites

• Node.js ≥ 20
• pnpm installed

Compile a plugin

Replace hello-plugin with your plugin's name:

PLUGIN=hello-plugin npx vite build --config plugins-dev/vite.config.plugin.ts

Examples with included plugins:

PLUGIN=trade-stats-plugin npx vite build --config plugins-dev/vite.config.plugin.ts

PLUGIN=file-processor-plugin npx vite build --config plugins-dev/vite.config.plugin.ts

Compile a release version

The release version is optimized and minified. It is intended for distribution.

PLUGIN=hello-plugin RELEASE=true npx vite build --config plugins-dev/vite.config.plugin.ts

Installation in TradeJourney

1. Go to Settings > Plugins.
2. Click Import plugin and select the generated .zip file.
3. Enable the plugin, then click Run.