From ede139556c169bc48aa4880d959fa3621210d82f Mon Sep 17 00:00:00 2001 From: Ariel Rotter-Aboyoun Date: Wed, 23 Oct 2024 11:43:43 -0700 Subject: [PATCH] Please use node 14 (updated READMEs) --- README.md | 5 ++++- angular/README.md | 1 + api/README.md | 2 ++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d62d011d4..b0090b9b5 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,10 @@ All documents uploaded to the NRPTI system are first checked by the ClamAV anti- # Running it locally -Please see the READMEs in the `angular/` and `api/` subdirectories. +**IMPORTANT:** Please read through this confluence page before running anything. +https://apps.nrs.gov.bc.ca/int/confluence/pages/viewpage.action?pageId=208740091 + +See the READMEs in the `angular/` and `api/` subdirectories for further instructions. # VSCode Extensions diff --git a/angular/README.md b/angular/README.md index 7c61abc67..acbf50762 100644 --- a/angular/README.md +++ b/angular/README.md @@ -16,6 +16,7 @@ Angular front-ends for the Natural Resources Public Transparency Interface (NRPT | npm | latest | https://www.npmjs.com/ | Node Package Manager | | ng | 7.x.x | https://cli.angular.io/ | Angular CLI | +_Note: Node 14.21.3 is highly recommended._ _Note: This app also requires [`bcgov/nrpti/api`](https://github.com/bcgov/NRPTI/tree/master/api) to handle its requests and authentication._ diff --git a/api/README.md b/api/README.md index 9c4636773..c23ae17cd 100644 --- a/api/README.md +++ b/api/README.md @@ -17,6 +17,8 @@ Run using the command `docker-compose up` to begin building and running the `api | yarn | latest | https://yarnpkg.com/en/ | Package Manager (more efficient than npm) | | mongodb | 3.4 - 3.6 | https://docs.mongodb.com/v3.6/installation/ | NoSQL database | +_Note: Node 14.21.3 is highly recommended._ + ## Install [NodeJS](https://nodejs.org/download/release/latest-v14.x/) _Note: NVM can be used to install and manage multiple versions of NodeJS and npm ([Windows version]((https://github.com/coreybutler/nvm-windows)), [Unix / Linux / macOS version](https://github.com/nvm-sh/nvm))._