Installation

Build from source

Run Mise locally with hot reload for development.

The source installation is intended for development and contribution. Use the published Docker image for ordinary production deployments.

Prerequisites

  • Node.js 20 or newer; development currently uses Node.js 24
  • pnpm through Corepack
  • Docker Engine or Docker Desktop
  • Git

Clone and install

git clone https://github.com/sidhantpanda/mise.git
cd mise
corepack enable
pnpm install

pnpm install also generates the Prisma client.

Start the development services

In the first terminal:

pnpm dev:db

This starts PostgreSQL, Adminer, and Meilisearch using compose.dev.yml.

In a second terminal:

pnpm dev

Open http://localhost:3000. The API is the front door and proxies the Vite frontend, including hot module replacement, so the entire product uses one origin.

Add demonstration data

pnpm db:seed

Sign in with:

Email:    demo@mise.app
Password: password

Seeding recreates only the demonstration household and leaves other accounts intact.

Common commands

CommandPurpose
pnpm devRun the API and frontend with hot reload
pnpm dev:dbRun development data services
pnpm buildBuild every workspace application, including documentation
pnpm lintLint all workspaces
pnpm testRun the complete Vitest suite
pnpm test:e2eBuild and run Playwright end-to-end tests
pnpm db:pushSynchronize Prisma schema changes
pnpm db:studioBrowse development data with Prisma Studio

Continue with the development guide before opening a pull request.

On this page