Clone, install, run. And what a clone build does not include.
Node 20 or newer.
git clone https://github.com/gixp/mindex.git
cd mindex
npm ci
npm run dev
| Command | Does |
|---|---|
npm run dev |
Run the app in development |
npm run typecheck |
Types only |
npm test |
The test suite |
npm run lint |
Lint |
npm run build |
Build the renderer and main process |
npm run release:mac |
Package a macOS installer |
npm run release:win |
Package a Windows installer |
npm run release:linux |
Package a Linux installer |
Analytics and crash reporting need keys that are not in the repository. Every one of those integrations turns itself off when its key is blank, so a build from a clone simply has none of them. Nothing is broken by their absence and nothing is reported anywhere.
AGPL-3.0. Fork it, change it, ship it — under the same licence.
Feature requests and questions go to Discussions. Bugs go to Issues.