Merge pull request #21 from department-of-veterans-affairs/chore/6692…

…-add-nvm

Chore/6692 add nvm

.github/workflows/code_checks.yml

@@ -11,10 +11,10 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version-file: '.nvmrc'
           cache: 'yarn'
       - name: Install dependencies
         run: yarn install --immutable
@@ -24,10 +24,10 @@ jobs:
     name: Unit Tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version-file: '.nvmrc'
           cache: 'yarn'
       - name: Install dependencies
         working-directory: packages/components

.github/workflows/publish-documentation.yml

@@ -32,12 +32,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version-file: '.nvmrc'
           cache: 'yarn'
 
       - name: Install global ependencies

.github/workflows/publish.yml

@@ -9,11 +9,11 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js 18.x
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version-file: '.nvmrc'
       - run: yarn install
       - name: Install dependencies in components
         run: yarn install

.nvmrc

@@ -0,0 +1 @@
+18.18.0

package.json

@@ -11,6 +11,9 @@
     "lint": "eslint .",
     "publish-workspaces": "yarn workspaces foreach --verbose --no-private npm publish --access public --tolerate-republish"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "homepage": "https://github.com/department-of-veterans-affairs/va-mobile-library#readme",
   "packageManager": "[email protected]",
   "devDependencies": {

packages/components/README.md

@@ -5,7 +5,8 @@
 ### Prerequisites
 
 1. Install [Node.js](https://nodejs.org/en)
-2. Install [yarn 3.6.1](https://yarnpkg.com/getting-started/install)
+2. Install [NVM](https://github.com/nvm-sh/nvm)
+3. Install [yarn 3.6.1](https://yarnpkg.com/getting-started/install)
 
 ### Installation
 
@@ -15,19 +16,21 @@
 git clone [email protected]:department-of-veterans-affairs/va-mobile-library.git
 ```
 
-2. Navigate to the components package
+2. From the root directory (`va-mobile-library`) run `nvm use`. If you do not have the active Node version installed (you will see an error) run `nvm install v18.18.0` (replacing v.18.18.0 with the version listed in our root-level .nvmrc file), then run `nvm use` to activate it.
+
+3. Navigate to the components package
 
 ```
 cd va-mobile-library/packages/components
 ```
 
-3. Install dependencies
+4. Install dependencies
 
 ```
 yarn
 ```
 
-4. Launch the app
+5. Launch the app
 
 - **Physical Device**
   1. Install the Expo Go app from the [App Store](https://itunes.apple.com/app/apple-store/id982107779) or [Play Store](https://play.google.com/store/apps/details?id=host.exp.exponent&referrer=www)