From 9f94b9177fa30b8195bb9cdc365983b1b1113761 Mon Sep 17 00:00:00 2001 From: isaaclombardssw Date: Fri, 7 Aug 2026 11:18:47 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Note=20Docker=20is=20optional,?= =?UTF-8?q?=20and=20pin=20down=20the=20Node/pnpm=20setup=20steps?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_01VRcoUyMuvLA51GPLK1Bdwo --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 53ac840f02..008f02075f 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,26 @@ This repository is a v3 of the SSW.Website. This website uses NextJS with TinaCM ## Requirements -- Git, [Node.js Active LTS](https://nodejs.org/en/about/releases/) +- Git, and the Node.js version pinned in [`.nvmrc`](.nvmrc) (currently v24.13.1). `nvm use` picks it up automatically. - pnpm `corepack enable pnpm` - A [TinaCMS](https://app.tina.io) account for live editing. ## Get Started +Select the pinned Node version and enable pnpm. Both are one-off, and Corepack ships with Node: + +```bash +nvm use +corepack enable pnpm +``` + Install the project's dependencies: ```bash pnpm install ``` -Run the project locally: +Run the project locally. This starts Next.js and the local TinaCMS server together, which is why there are two ports below: ```bash pnpm dev @@ -51,7 +58,9 @@ Build the project: pnpm build ``` -## Build the Docker image locally: +## Build the Docker image locally (optional) + +Docker is not required for day-to-day development. `pnpm dev` above is usually the quicker path, and is easier to debug. Build the image when you need to reproduce the deployed container, for example to chase a build or runtime problem that only shows up there. To build the Docker image, execute the following command to extract the necessary Docker build command: