From 34c9361c40dd9c0b3cb51715cc10be994ffaedd7 Mon Sep 17 00:00:00 2001 From: Josh Creek <8179928+jcreek@users.noreply.github.com> Date: Wed, 16 Apr 2025 22:27:50 +0100 Subject: [PATCH] docs(*): Update instructions for running the project --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55daa03..77d0b33 100644 --- a/README.md +++ b/README.md @@ -77,11 +77,27 @@ This project uses [SvelteKit](https://kit.svelte.dev/) and [TypeScript](https:// - [pnpm](https://pnpm.io/installation) ### Installation & Running Locally + +#### Developing + +Once you've installed dependencies with `pnpm install`, start a development server: + ```bash -pnpm install -pnpm dev +pnpm run dev + +# or start the server and open the app in a new browser tab +pnpm run dev -- --open ``` -The app will be available at `http://localhost:5173` (or the port shown in your terminal). + +#### Building + +To create a production version: + +```bash +pnpm run build +``` + +You can preview the production build with `npm run preview`. ---