Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
86 lines (61 loc) · 1.84 KB

DEPLOYMENT.md

File metadata and controls

86 lines (61 loc) · 1.84 KB
Raw

TaskFlow — Deployment Guide

Prerequisites

  • Windows 10/11 (64-bit)
  • Node.js 20+ and npm

Development

cd taskflow
.\scripts\dev.ps1

Or manually:

npm install
npm run dev

Production Build

.\scripts\build.ps1

Or directly:

npm run dist            # NSIS installer + portable
npm run dist:portable   # portable only

Output (in release/):

  • TaskFlow Setup x.x.x.exe — NSIS installer
  • TaskFlow x.x.x.exe — Portable executable

The app icon is resources/icon.ico (256×256 multi-size).

Troubleshooting: "Cannot create symbolic link … A required privilege is not held"

On Windows, electron-builder unpacks its winCodeSign toolchain, which contains macOS symlinks. Extracting symlinks requires privilege. Either:

  • Enable Settings → Privacy & security → For developers → Developer Mode, or run the build shell as Administrator; or

  • Pre-extract the archive without the (unused on Windows) darwin folder into the cache path electron-builder expects, e.g.:

    $c = "$env:LOCALAPPDATA\electron-builder\Cache\winCodeSign"
& ".\node_modules\7zip-bin\win\x64\7za.exe" x "$c\<archive>.7z" "-o$c\winCodeSign-2.6.0" "-xr!darwin"

Windows builds don't need the macOS files, so excluding them is safe.

Data Location

%APPDATA%\taskflow\data\taskflow.db
%APPDATA%\taskflow\data\backups\

Code Signing (Production)

  1. Obtain a code signing certificate
  2. Add to package.json build config:
"win": {
  "certificateFile": "path/to/cert.pfx",
  "certificatePassword": "password"
}

Auto-Update (Future)

Integrate electron-updater with a release server (GitHub Releases recommended).

System Requirements

Metric Minimum
RAM 256 MB
Disk 200 MB
Display 1100×700