YieldlyX Standalone

YieldlyX Standalone is an Electron desktop wrapper for OpenTrader that runs entirely on your local machine.

Scope and Behavior

• OpenTrader engine runs at http://127.0.0.1:8000.

• On first run, the app asks for an admin password, initializes a local SQLite database, then launches OpenTrader inside the desktop window.

• If no exchange account is configured, the UI guides users to the Accounts screen before strategy/bot routes.

Requirements

• Node.js >= 22

• npm

• Windows, macOS, or Linux (Electron-based runtime)

Quick Start

npm install

npm start

npm install downloads dependencies and automatically sets up the OpenTrader Prisma client, Electron binary, and required patches. No extra setup step is required.

Runtime Data (Local)

The app stores OpenTrader runtime data in Electron userData under an opentrader folder:

• pass - local admin password file

• dev.db - local SQLite database

• strategies/ - custom strategy files

All of these are local files on the same machine where the app runs.

Available Scripts

• npm start - start the desktop app (re-checks Prisma/Electron if needed)

• npm run setup - re-run the same setup as npm install postinstall

• npm run setup:deps - alias for npm run setup

• npm run reinstall - clean node_modules and full reinstall

• npm run kill:engine - force-free port 8000 before startup

• npm run icons - regenerate app icon assets

• npm run build:win - build Windows installer

• npm run build:mac - build macOS package

• npm run build:linux - build Linux package

• npm run build - run default electron-builder target

Build Notes

The build pipeline runs a prebuild step that:

1. Generates OpenTrader Prisma client (scripts/generate-opentrader-prisma.mjs)

2. Generates app icons (scripts/generate-app-icon.mjs)

During packaging, scripts/after-pack.mjs copies OpenTrader .prisma assets into the unpacked app resources.

Troubleshooting

Prisma client not found near OpenTrader

npm run setup

npm start

npm install / postinstall issues

If install fails or scripts were skipped:

npm install --ignore-scripts

npm run setup

npm start

Port 8000 already in use

npm run kill:engine

Windows lock/EBUSY during reinstall

powershell -ExecutionPolicy Bypass -File .\scripts\clean-install.ps1

macOS/Linux reinstall cleanup

sh ./scripts/clean-install.sh