Use corepack pnpm instead of volta npm

.github/workflows/ci.yaml

@@ -19,42 +19,51 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - name: Install node and npm
+      # Pulls version from packageManager key in package.json
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+      - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
-          cache: npm
+          cache: 'pnpm'
       - name: Install dependencies
-        run: npm ci
+        run: pnpm install
       - name: Typecheck
-        run: npm run typecheck
+        run: pnpm typecheck
   format:
     name: Check prettier
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - name: Install node and npm
+      # Pulls version from packageManager key in package.json
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+      - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
-          cache: npm
+          cache: 'pnpm'
       - name: Install dependencies
-        run: npm ci
+        run: pnpm install
       - name: Check formatting
-        run: npm run format:check
+        run: pnpm format:check
   test:
     name: Test
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
-      - name: Install node and npm
+      # Pulls version from packageManager key in package.json
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+      - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
-          cache: npm
+          cache: 'pnpm'
       - name: Install dependencies
-        run: npm ci
+        run: pnpm install
       - name: Test
-        run: npm run test
+        run: pnpm test

.nvmrc

@@ -1 +1 @@
-18.16.0
+20.9.0

.prettierignore

@@ -0,0 +1,34 @@
+# build output
+build
+
+# ignore docusaurus cache files
+.docusaurus
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# dependencies
+node_modules/
+pnpm-lock.yaml
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+tsconfig.tsbuildinfo

README.md

@@ -6,7 +6,28 @@ This is the documentation for the [nebula open source project](https://github.co
 
 All commands are run from the root of the project, from a terminal:
 
-| Command       | Action                                      |
-| :------------ | :------------------------------------------ |
-| `npm install` | Installs dependencies                       |
-| `npm start`   | Starts local dev server at `localhost:3000` |
+| Command        | Action                                      |
+| :------------- | :------------------------------------------ |
+| `pnpm install` | Installs dependencies                       |
+| `pnpm start`   | Starts local dev server at `localhost:3000` |
+
+## Environment setup
+
+#### Node.js and pnpm
+
+To develop this code, you'll need node.js. The exact version you get doesn't matter much, as long as it meets the
+requirements set in the `package.json` `engines` field, but you can reference the value in `.nvmrc` for the version that
+is used in CI.
+
+You can install node.js directly from https://nodejs.org/en/download/, or you can use a tool like
+[fnm](https://github.com/Schniz/fnm) to handle automatically changing your node version when switching between projects
+with different requirements.
+
+To get `pnpm`, run `corepack enable` after installing `node`, and `corepack` should install the right `pnpm` version for
+you.
+
+#### Project dependencies
+
+To install our javascript dependencies, run `pnpm install` (or `pnpm i` for short). You'll want to do this whenever you
+change branches, if there's a possibility that dependencies have been changed or updated. If you're not able to start up
+the client app, this is a good first troubleshooting step to take.