Skip to content

Installation

TickMint ships as a desktop app with the gateway built in. You don’t need Node.js, a database server or any other service to run the packaged app.

Install the desktop app

To get the installers, start a 14-day free trial, then use the download link in your purchase email (or go to tickmint.net/download). Your license key is in the same email; paste it into TickMint on first launch.

Builds are available as a .dmg and a .zip for Apple Silicon (arm64) and Intel (x64).

  1. Download the build that matches your Mac.
  2. Open the .dmg and drag TickMint into Applications.
  3. Launch TickMint from Applications or Spotlight.

The packaged app doesn’t use fixed ports. Its gateway listens on an OS-assigned loopback port and the UI loads from an internal app://tickmint origin, so you won’t get a firewall prompt and nothing is exposed on your network.

Where your data lives

The packaged app keeps everything in its user-data folder:

OS Folder
macOS ~/Library/Application Support/TickMint
Windows %APPDATA%\TickMint
Linux ~/.config/TickMint
What Location
Database (settings, layouts, credentials, journal) tickmint.db in the user-data folder
Logs logs/ in the user-data folder
Encryption key for stored credentials .secret.key.enc in the user-data folder, protected by the OS keychain

When you run from source, the database is services/gateway/data/tickmint.db in the repository.

Run from source

Use this to develop on TickMint or build your own packages.

Requirements: Node.js 22.5 or later (the gateway uses the built-in node:sqlite module) and npm 10+.

  1. Install dependencies from the repository root:

    Terminal window
    npm install
  2. Start the gateway and the web UI together:

    Terminal window
    npm run dev

    Or start them in separate terminals with npm run dev:gateway and npm run dev:web.

  3. Open http://localhost:3000 in your browser, or run the desktop shell against the dev servers with npm run dev:electron.

Default dev ports:

Service Address Override
Gateway (HTTP + WebSocket) 127.0.0.1:8080 (ws://localhost:8080) TM_GATEWAY_PORT or PORT
Web UI (Vite) http://localhost:3000 TM_VITE_PORT

The Vite port is strict: if 3000 is busy, the dev server exits instead of picking another port. Set the override variables (for example TM_GATEWAY_PORT=18080 TM_VITE_PORT=13000) to run a second copy.

Other gateway environment variables:

Variable Purpose
TM_DATA_DIR Folder for tickmint.db
TM_LOG_DIR Folder for log files
TM_BIND_HOST Bind address. Loopback by default. Any other address is an explicit LAN opt-in and requires TM_SESSION_TOKEN.
TM_SESSION_TOKEN Fixed session secret, at least 24 characters for LAN use. Without it, a random token is generated on every start and never written to disk. Remote browsers open the UI with ?tm_token= followed by the secret.

Build packages

Terminal window
npm run build:all
npm run dist:mac # or dist:win / dist:linux

Installers are written to apps/electron/release.

First launch

TickMint opens offline. Until you add a Rithmic connection:

  • Charts show no market data and the header shows the feed as offline.
  • The SIM-1 paper account can’t fill orders, because simulated fills need live ticks.
  • Market Replay is unavailable, because it logs in through a Rithmic connection.

There is no built-in demo feed. Continue with the Quickstart to connect your Rithmic account.