Skip to content

Installation

MikroPlan can run as a local-only static app or as an API-backed app with a shared SQLite workspace.

  • Node.js 25 or newer.
  • A static file server for local testing.

Download the static app archive:

Terminal window
curl -sSL -o mikroplan_app.zip https://releases.mikrosuite.com/mikroplan_app_latest.zip
unzip mikroplan_app.zip -d mikroplan_app
cd mikroplan_app/*
npx http-server . -a 127.0.0.1 -p 8000 -c-1

Open http://127.0.0.1:8000. Local-only mode stores data in the browser.

Download the API archive and point it at the extracted app:

Terminal window
mkdir -p mikroplan/api mikroplan/app
ROOT="$PWD/mikroplan"
curl -sSL -o "$ROOT/mikroplan_app.zip" https://releases.mikrosuite.com/mikroplan_app_latest.zip
curl -sSL -o "$ROOT/mikroplan_api.zip" https://releases.mikrosuite.com/mikroplan_api_latest.zip
unzip -q "$ROOT/mikroplan_app.zip" -d "$ROOT/app"
unzip -q "$ROOT/mikroplan_api.zip" -d "$ROOT/api"
APP_DIR="$(find "$ROOT/app" -mindepth 1 -maxdepth 1 -type d | head -n 1)"
API_DIR="$(find "$ROOT/api" -mindepth 1 -maxdepth 1 -type d | head -n 1)"
cd "$API_DIR"
cp mikroplan.config.json.example mikroplan.config.json
node server.mjs --static-root "$APP_DIR"

The API listens on http://127.0.0.1:3000 by default and serves the app from the configured static root.

The latest release archives are available from GitHub Releases and these stable URLs:

  • https://releases.mikrosuite.com/mikroplan_app_latest.zip - static browser app
  • https://releases.mikrosuite.com/mikroplan_api_latest.zip - Node API bundle