Skip to content

Run it locally

OpenNord is a React 19 + Vite + TypeScript web app. The same code runs in the browser, in the desktop app (Electron) and in the iPad app (Capacitor).

  • Node.js 22 or newer, and npm.
  • git.
  • For device work: a Chromium-based browser on a computer (Chrome, Edge, Brave, Arc, Opera) and a Nord with a USB cable. Nothing else needs hardware.
Terminal window
git clone https://github.com/simonflore/opennord.git
cd opennord
npm install
npm run dev # the app at http://localhost:5173

The app opens on the Library. Import a Nord file or connect a folder and it reads it straight away.

These three are the CI gates. Run them before you open a pull request:

Terminal window
npm run typecheck # tsc --noEmit
npm run lint # eslint + stylelint (no hard-coded colours outside tokens.css)
npm test # vitest

Other useful commands:

Command What it does
npm run build Production build into dist/
npm run preview Serve the production build
npm run test:watch Vitest in watch mode
npm run lint:fix Fix what eslint and stylelint can fix on their own
npm run electron:dev The desktop app against the dev server

These pages live in the same repository, in docs-site/. It is a separate npm project:

Terminal window
cd docs-site
npm install
npm run dev # http://localhost:4321/docs/
npm run build # static site into docs-site/dist/

See Write the docs for how pages are organised.