From 37ab24be749d37b0e67ed82111303f10e1cdb150 Mon Sep 17 00:00:00 2001 From: Gabriel Kaszewski Date: Tue, 9 Jun 2026 00:06:22 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20npm=20=E2=86=92=20bun?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 6 +++--- README.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 555d5cd..3c27b67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Thanks for your interest in Movies Diary! This is a personal project but contrib 1. Fork and clone the repo 2. Copy `.env.example` to `.env` and fill in at least `JWT_SECRET` and `OMDB_API_KEY` -3. Install Rust (stable, 2024 edition) and Node.js (for the SPA) +3. Install Rust (stable, 2024 edition) and Bun (for the SPA) 4. Run the backend and worker: ```bash @@ -17,7 +17,7 @@ cargo run -p worker # event worker (separate terminal) 5. Run the SPA dev server: ```bash -cd spa && npm install && npm run dev +cd spa && bun install && bun run dev ``` ## Before submitting a PR @@ -32,7 +32,7 @@ Or individually: cargo fmt --check cargo clippy -- -D warnings cargo test -cd spa && npx tsc --noEmit +cd spa && bunx tsc --noEmit ``` All four must pass. PRs with clippy warnings or failing tests won't be merged. diff --git a/README.md b/README.md index fdb1f52..873067c 100644 --- a/README.md +++ b/README.md @@ -166,12 +166,12 @@ Interactive API documentation is available at runtime: The single-page app lives in `spa/` and is served at `/app/` by the backend. For local development: ```bash -cd spa && npm install && npm run dev # http://localhost:5173/app/ +cd spa && bun install && bun run dev # http://localhost:5173/app/ ``` Set `CORS_ORIGINS=http://localhost:5173` in the backend `.env` to allow cross-origin API calls during development. -For production, `npm run build` outputs to `spa/dist/` which the backend serves statically (included in Docker image automatically). +For production, `bun run build` outputs to `spa/dist/` which the backend serves statically (included in Docker image automatically). ## Terminal UI (deprecated)