Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment on lines +30 to 32

## 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
Expand All @@ -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:

Expand Down
Loading