Files
open-science/docs/development-quick-reference.md
Ewen 6d905f872d ci(node): migrate development and CI to Node 24 (#3056)
* ci(node): migrate development and CI to Node 24

Keep the published CLI minimum at Node 22.5 and add a blocking Node 22 CLI/SDK compatibility check. Preserve the Electron runtime, its Node types, and exact E2E producer/consumer runtime matching.

* ci(build): align reusable build caller OIDC permissions

* ci(build): add unsigned Windows package dry-run
2026-09-26 06:00:19 -07:00

1.7 KiB

AIPOCH Open-Science — Development & Packaging

AIPOCH Open-Science is an Electron application built with React, TypeScript, Prisma/SQLite, and an ACP-based agent runtime.

Prerequisites for source development:

  • Node.js 24 (see .nvmrc) with npm
  • Git
  • Notebook execution optionally uses app-managed Python/R environments or a compatible interpreter you configure.
git clone https://github.com/aipoch/open-science.git
cd open-science
npm install
npm run dev

npm install automatically generates the Prisma client and installs Electron native dependencies. npm run dev builds the Electron main/preload bundles, starts the renderer, and opens the desktop app. Development data is isolated under ~/.open-science-project.

Useful commands:

Command Purpose
npm run dev Start the development application
npm run dev:web Dev app + localhost web UI (127.0.0.1)
npm run dev:headless Dev backend + web UI, no Electron window
npm run lint Run ESLint
npm run typecheck Type-check main and renderer code
npm test Run the Vitest suite
npm run build Type-check and build the application
npm run build:web Build the optional localhost web UI
npm run build:mac Package macOS builds
npm run build:win Package Windows builds
npm run build:linux Package Linux builds

Packaged output is written under dist/.

README