Run from Source
Start a development server from source with Bun and Node.js, or build and run the production version.
Requirements
| Tool | Version | Declared in |
|---|---|---|
| Node.js | 26, at least 26.12.1 | .nvmrc pins 26.12.1. The engines field of package.json is >=26.12.1 <27 |
| Bun | 1.4.4 | The packageManager field of the root package.json |
The build and the Node.js standalone runtime need Node.js 26, version 26.12.1 or later. The project uses Bun as its package manager. Install Bun with one of these methods:
curl -fsSL https://bun.sh/install | bashStart the development server
Clone the repository
git clone https://github.com/Alice39s/kuma-mieru.git
cd kuma-mieruInstall the dependencies
Run this command in the repository root. It installs the dependencies of all workspaces:
bun installConfigure the environment variables
The web application reads .env from the apps/web directory. Copy the template:
cp apps/web/.env.example apps/web/.envEdit apps/web/.env and set UPTIME_KUMA_URLS:
UPTIME_KUMA_URLS=https://example.kuma-mieru.invalid/status/your-status-page-idFor multiple status pages, separate the URLs with |:
UPTIME_KUMA_URLS=https://status.kuma-mieru.invalid/status/prod|https://status.kuma-mieru.invalid/status/stagingThe template lines KUMA_MIERU_TITLE, KUMA_MIERU_DESCRIPTION and KUMA_MIERU_ICON replace the title, description and icon of the status page. To keep the values of the status page, delete these three lines.
For the required variables and the other variables, see Environment Variables.
Start
bun run devTurborepo starts the web application and the docs site together. Open http://localhost:3881 to see the dashboard. The docs site runs at http://localhost:3882.
To start only the web application, run:
bunx turbo run dev --filter=@kuma-mieru/webThe dev script of the web application runs generate and lint:fix, then starts the Next.js development server.
Build and run the production version
Run these commands in the apps/web directory:
cd apps/web
bun run build
bun run startbun run buildrunsgenerate, then runsnext buildto create the standalone output.bun run startrunsgenerateagain, copies the static files into the standalone output directory, then runs.next/standalone/apps/web/server.jswith Bun.- The server listens on port 3000 by default.
If you run bun run build in the repository root, Turborepo builds the web application and the docs site together.
Last updated on