From 992f62bd3f8ef1fe9e4fa3b36a187b82f4d7912b Mon Sep 17 00:00:00 2001
From: f-w <fred.wen@gov.bc.ca>
Date: Thu, 19 Dec 2024 10:26:54 -0800
Subject: [PATCH] updated docs

---
 docs/docs/getting-started/quickstart.md | 13 +++++++++++--
 docs/docs/getting-started/what's-new.md |  2 +-
 package-lock.json                       | 19 +++++++++++++++++++
 package.json                            |  1 +
 4 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.md
index 00e9546d7..3469168d2 100644
--- a/docs/docs/getting-started/quickstart.md
+++ b/docs/docs/getting-started/quickstart.md
@@ -4,13 +4,22 @@ permalink: /docs/quickstart/
 
 # Quick Start
 
-For the impatient, here's how to get a boilerplate _NotifyBC_ instance up and running if you have git and node.js installed:
+For the impatient, to get _NotifyBC_ instance up and running on localhost, you need
+
+- internet connection
+- Node.js
+- git
+- (Windows only) Docker Desktop running
+
+then run
 
 ```sh
+docker run --rm -dp 6379:6379 redis # only on Windows
 git clone https://github.com/bcgov/NotifyBC.git
 cd NotifyBC
 npm i && npm run build
-npm run start
+npx cross-env NOTIFYBC_WORKER_PROCESS_COUNT=1 npm run start
+# wait till console displays "ethereal email account created:"
 # => Now browse to http://localhost:3000
 ```
 
diff --git a/docs/docs/getting-started/what's-new.md b/docs/docs/getting-started/what's-new.md
index 16520358d..77a109cd0 100644
--- a/docs/docs/getting-started/what's-new.md
+++ b/docs/docs/getting-started/what's-new.md
@@ -11,7 +11,7 @@ _NotifyBC_ uses [semantic versioning](https://semver.org/).
 
 See [Upgrade Guide](../upgrade/#v5-to-v6) for more information.
 
-- Replaced Bottleneck with BullMQ
+- Issue [#89](https://github.com/bcgov/NotifyBC/issues/89) Replaced Bottleneck with BullMQ
 - Redis is required
 - Bitnami Redis Helm chart is updated from version 16.13.2 to 20.4.1, with corresponding Redis from 6.2.7 to 7.4.1
 - Bitnami MongoDB Helm chart is updated from version 14.3.2 to 16.3.3, with corresponding MongoDB from 7.0.4 to 8.0.4
diff --git a/package-lock.json b/package-lock.json
index 3b2acc10d..d9679c9ce 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -61,6 +61,7 @@
         "@typescript-eslint/eslint-plugin": "^8.18.0",
         "@typescript-eslint/parser": "^8.18.0",
         "commander": "^11.1.0",
+        "cross-env": "^7.0.3",
         "csvtojson": "^2.0.10",
         "eslint": "^8.42.0",
         "eslint-config-prettier": "^8.8.0",
@@ -4678,6 +4679,24 @@
         "node": ">=12.0.0"
       }
     },
+    "node_modules/cross-env": {
+      "version": "7.0.3",
+      "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-7.0.3.tgz",
+      "integrity": "sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==",
+      "dev": true,
+      "dependencies": {
+        "cross-spawn": "^7.0.1"
+      },
+      "bin": {
+        "cross-env": "src/bin/cross-env.js",
+        "cross-env-shell": "src/bin/cross-env-shell.js"
+      },
+      "engines": {
+        "node": ">=10.14",
+        "npm": ">=6",
+        "yarn": ">=1"
+      }
+    },
     "node_modules/cross-spawn": {
       "version": "7.0.6",
       "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz",
diff --git a/package.json b/package.json
index 3457db9f9..0e382a963 100644
--- a/package.json
+++ b/package.json
@@ -88,6 +88,7 @@
     "@typescript-eslint/eslint-plugin": "^8.18.0",
     "@typescript-eslint/parser": "^8.18.0",
     "commander": "^11.1.0",
+    "cross-env": "^7.0.3",
     "csvtojson": "^2.0.10",
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^8.8.0",