From 88a1b90ffc72a76f971cf2291c9e17836b84ee45 Mon Sep 17 00:00:00 2001
From: hunterckx <118154470+hunterckx@users.noreply.github.com>
Date: Fri, 6 Sep 2024 13:17:55 -0700
Subject: [PATCH] docs: add instructions for running locally to readme (#24)

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index fc8ca4f..d5d46c0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,17 @@
 # brc-analytics
 
+## Setup
+
+Using Node.js version `20.10.0`, run `npm install` in the root directory of the repository to install dependencies.
+
+## Using the development server
+
+The app can be run for development using `npm run dev`, and accessed at `http://localhost:3000`.
+
+## Building the app locally
+
+Run `npm run build:local` to build. The built app can be run using `npm start`, and accessed at `http://localhost:3000`.
+
 # BRC Analytics Data Catalog
 
 ## Building the data source files