From eaa25adfea1b9ce79b86b8351f4960757031f236 Mon Sep 17 00:00:00 2001 From: haliphax Date: Wed, 22 Jan 2025 10:58:13 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20"run=20locally"=20section=20in?= =?UTF-8?q?=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 938c144..d57c650 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,26 @@ Simple [story points][] estimation - [Remult][] - Data access layer - [Vitest][] - Testing framework +## Run locally + +Install dependencies: + +```bash +npm ci +``` + +Build the client web app: + +```bash +npm run build +``` + +Start the app server: + +```bash +npm run start +``` + [css grid]: https://developer.mozilla.org/en-us/docs/web/css/css_grid_layout [demonstration app]: https://sphenoid-secret-antimony.glitch.me [express]: https://expressjs.com