Skip to content

installation.md

Latest commit

 

History

History
107 lines (70 loc) · 3.3 KB

installation.md

File metadata and controls

107 lines (70 loc) · 3.3 KB
Raw

Installation

How to install and run HPPM v0.26.

Related: Splash & projects · Data model · Root README

Windows (recommended)

HPPM ships as a single NSIS installer for Windows x64.

  1. Download HPPM_v026.exe from the v0.26 release.
  2. Run the installer. Default location: C:\Program Files\HPPM — you can change this during setup.
  3. Launch HPPM from the Start Menu or desktop shortcut. A brief branded splash appears while the app loads.
  4. On first launch you see the splash screen — pick or create a project.

SmartScreen warning

The beta installer is not code-signed. Windows SmartScreen may show “Windows protected your PC.” Choose More info → Run anyway if you trust the publisher (ARPA Hellenic Logical Systems).

What the installer includes

Component Role
Electron shell Window, icon, single-instance app
Bundled UI Production build of hppm-ui
API server Reads/writes markdown and .hppm on your disk
Installer art v0.26 sidebar and header graphics
Launch splash Branded loading window while server starts

The desktop app does not use File / Edit / Help menus — only the HPPM UI you see in the web build.

Desktop data paths

Item Location
Application C:\Program Files\HPPM (or your chosen path)
Project registry Electron userData folder (via HPPM_DATA_DIR) — not inside Program Files
Your projects Wherever you put them — any folder you pick on splash

Your markdown trackers never live inside the install directory unless you put them there.

From source (development)

For contributors or advanced users who want to run from the repo:

cd hppm-ui
npm install
npm run dev

Opens http://localhost:5173. The dev server includes the same API middleware as desktop.

npm run build    # → dist/
npm run preview  # serve production build locally

Requirements

  • Node.js 20+ recommended
  • npm (comes with Node)
  • A modern browser (Chrome, Edge, Firefox)

Desktop packaging (build your own installer)

The sibling folder hppm-desktop (outside this repo’s git root) wraps the UI:

cd hppm-desktop
npm install
npm run dist

Output: hppm-desktop/release/HPPM_v026.exe

This runs hppm-ui production build, bundles the standalone server, and converts v0.26 installer PNGs to NSIS bitmaps. See hppm-desktop/README.md in your checkout.

Desktop vs browser dev

Aspect Browser / npm run dev Windows installer
UI Identical Identical
API Vite dev middleware Bundled standaloneServer
Project registry file .hppm-projects.json under UI root UserData via HPPM_DATA_DIR
Offline Yes (local server) Yes
Accounts / cloud None None

There is no feature gap between modes — only where the registry file is stored.

After installation

→ Continue with Splash & projects to open your first workspace.

← Docs index