Deployment

📦 Packaging & Distribution Guide

VisualMark Studio compiles into fully standalone desktop executables and installers that run completely offline without requiring Node.js or Python to be pre-installed on the user's machine.

---

🛠️ Build Pipeline Overview

[FastAPI Python Code] ──(PyInstaller)──> [server.exe Sidecar]
                                                │
[React 18 / Monaco]   ──(Vite Build)───> [dist/ HTML/JS]
                                                │
                                       (Electron-Builder)
                                                │
                    ┌───────────────────────────┴───────────────────────────┐
                    ▼                                                       ▼
        [Portable Standalone .exe]                            [NSIS Full Setup Installer]

---

🚀 Step-by-Step Build Instructions

Step 1: Compile the Python Sidecar Daemon

The FastAPI documentation engine must first be frozen into a standalone binary:

cd backend
python build_sidecar.py

• Output Artifact: frontend/resources/backend-sidecar/server.exe
• Note: This step requires PyInstaller (pip install pyinstaller).

---

Step 2: Build the Frontend Production Assets

Compile the React frontend bundle with Vite:

cd ../frontend
npm run build

• Output Artifact: frontend/dist/

---

Step 3: Package the Desktop Application

Target A: Portable Standalone Executable (Zero Install)

Creates a single .exe file that can be run from any folder, USB drive, or cloud directory without installation:

npm run electron:build:portable

• Output Artifact: frontend/release/VisualMark-Studio-Portable.exe

Target B: Full Windows Installer (NSIS)

Creates a complete setup wizard with Start Menu shortcuts, Desktop icons, and file association:

npm run electron:build:installer

• Output Artifact: frontend/release/VisualMark-Studio-Setup.exe

Target C: Build Both Targets

To generate both portable and installer packages concurrently:

npm run electron:build

---

🛡️ Windows SmartScreen Guidance

Because VisualMark Studio is open-source and distributed without an expensive corporate Extended Validation (EV) code-signing certificate, Windows SmartScreen may display an "Unrecognized app" warning on initial launch.

• For Users: Click More info $\rightarrow$ Run anyway to launch the application.
• The application code is 100% open source, inspectable, and runs locally with zero telemetry.

---

Return to Home or continue to Contributing Guidelines.