updated docs

bcgov · Dec 19, 2024 · 992f62b · 992f62b
1 parent b9b9ce1
commit 992f62b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git 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
@@ -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
diff --git 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",