From 6652fed0a7585680e9f11c8d7f17b0c7ea4acf46 Mon Sep 17 00:00:00 2001 From: Garrett Jones Date: Thu, 7 Nov 2024 20:48:12 -0500 Subject: [PATCH 1/2] Update README for installing convert dependencies To fully run the PWA, `npm install` must be run in the root directory and in convert/. Updated README.md to document this procedure. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39a00fea9..136477c4c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,14 @@ You will need to download the latest version of [Scripture App Builder](https:// ### Develop -Install dependencies with `npm install`. +Install dependencies by running `npm install` in the root directory and in convert: + +```bash +npm install +cd convert/ +npm install +cd .. +``` The PWA depends on data files generated by Scripture App Builder. There is example data provided in the repo. To convert the base data files and run the PWA, do one of the following: From dd5c0c1aac42db29f88fa7e564753a2ac7d69ca0 Mon Sep 17 00:00:00 2001 From: Garrett Jones Date: Thu, 7 Nov 2024 20:57:11 -0500 Subject: [PATCH 2/2] Edit instructions for installing dependencies `npm install` only needs to be run in `convert` if you are using SAB to generate data files. The example data does not depend on convert/. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 136477c4c..2644bf538 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,10 @@ You will need to download the latest version of [Scripture App Builder](https:// ### Develop -Install dependencies by running `npm install` in the root directory and in convert: +Install dependencies using `npm install`. + +If you use Scripture App Builder to generate data files, you must run `npm install` twice: +once in the root directory and once in `convert/`: ```bash npm install