Skip to content

Commit 88a1b90

Browse files
committed
docs: add instructions for running locally to readme (#24)
1 parent d595e28 commit 88a1b90

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# brc-analytics
22

3+
## Setup
4+
5+
Using Node.js version `20.10.0`, run `npm install` in the root directory of the repository to install dependencies.
6+
7+
## Using the development server
8+
9+
The app can be run for development using `npm run dev`, and accessed at `http://localhost:3000`.
10+
11+
## Building the app locally
12+
13+
Run `npm run build:local` to build. The built app can be run using `npm start`, and accessed at `http://localhost:3000`.
14+
315
# BRC Analytics Data Catalog
416

517
## Building the data source files

0 commit comments

Comments
 (0)