chore(repo): 🏗️ set min node/pnpm versions (#92)

Author: OmarMcAdam

README.md

@@ -78,13 +78,15 @@ Instead, we're detaching from its legacy underpinnings, to build something moder
 _p.s. Things will change over time!_
 
 ## Running Locally
+
 To get a local copy up and running, follow these simple steps.
 
 ### Prerequisites
 
 Here is what you need to be able to run UnInbox locally.
 
 - Node.js (Version: >=20.x)
+- NVM (Node Version Manager) (see https://github.com/nvm-sh/nvm)
 - Docker
 - pnpm (see https://pnpm.io/installation)
 
@@ -105,38 +107,47 @@ Here is what you need to be able to run UnInbox locally.
    cd UnInbox
    ```
 
-3. Install packages with pnpm
+3. Check and install the correct node/pnpm versions
+
+   ```sh
+   nvm install
+   ```
+
+4. Install packages with pnpm
 
    ```sh
    pnpm i
    ```
 
-4. Set up your `.env.local` file
+5. Set up your `.env.local` file
 
    - Duplicate `.env.local.example` to `.env.local`. This file is already pre-configured for use with the local docker containers
 
-      mac
+     mac
+
      ```sh
       cp .env.local.example .env.local
      ```
+
      windows
+
      ```sh
       copy .env.local.example .env.local
      ```
 
-5. Start the docker containers
+6. Start the docker containers
 
    ```sh
    pnpm run docker:up
    ```
-   
-6. Sync the schema with the database:
 
-    ```sh 
+7. Sync the schema with the database:
+
+   ```sh
    pnpm run db:push
-    ```
+   ```
 
-7. In another terminal window, start the app and all services
+8. In another terminal window, start the app and all services
 
    ```sh
    pnpm run dev

apps/landing-page/package.json

@@ -2,6 +2,10 @@
   "name": "@uninbox/landing",
   "private": true,
   "type": "module",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "build": "nuxt build",
     "dev": "PORT=3500 nuxt dev",
@@ -36,4 +40,4 @@
   "overrides": {
     "vue": "3.3.13"
   }
-}
+}

apps/mail-bridge/package.json

@@ -2,6 +2,10 @@
   "name": "@uninbox/mail-bridge",
   "private": true,
   "types": "types.ts",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "dev": "PORT=3100 npx nitropack dev",
     "build": "npx nitropack build",

apps/storage/package.json

@@ -2,6 +2,10 @@
   "name": "@uninbox/storage",
   "private": true,
   "types": "types.ts",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "dev": "PORT=3200 npx nitropack dev",
     "build": "npx nitropack build",

apps/web-app/package.json

@@ -2,6 +2,10 @@
   "name": "@uninbox/web-app",
   "private": true,
   "type": "module",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "build": "nuxt build",
     "dev": "PORT=3000 nuxt dev --host",

ee/apps/billing/package.json

@@ -3,6 +3,10 @@
   "license": "COMMERCIAL",
   "private": true,
   "types": "types.ts",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "ee:dev": "PORT=3800 npx nitropack dev",
     "ee:build": "npx nitropack build",

ee/packages/types/package.json

@@ -2,6 +2,10 @@
     "name": "@uninbox-ee/types",
     "private": true,
     "version": "1.0.0",
+    "engines": {
+        "node": ">=20",
+        "pnpm": ">=8"
+    },
     "description": "",
     "main": "index.ts",
     "types": "index.ts",

packages/database/package.json

@@ -3,6 +3,10 @@
   "private": true,
   "types": "./index.ts",
   "main": "index.js",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "db:generate": "drizzle-kit generate:mysql --config=drizzle.config.ts",
     "db:push": "drizzle-kit push:mysql --config=drizzle.config.ts",

packages/postal-puppet/package.json

@@ -29,6 +29,10 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "scripts": {
     "build:puppet": "unbuild",
     "dev:puppet": "unbuild --stub",

packages/trpc/package.json

@@ -4,6 +4,10 @@
     "private": true,
     "description": "",
     "main": "index.js",
+    "engines": {
+        "node": ">=20",
+        "pnpm": ">=8"
+    },
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1"
     },

packages/types/package.json

@@ -5,6 +5,10 @@
     "description": "",
     "main": "index.ts",
     "types": "index.ts",
+    "engines": {
+        "node": ">=20",
+        "pnpm": ">=8"
+    },
     "devDependencies": {
         "typescript": "^5.3.3"
     }

packages/utils/package.json

@@ -8,6 +8,10 @@
   "keywords": [],
   "author": "",
   "license": "ISC",
+  "engines": {
+    "node": ">=20",
+    "pnpm": ">=8"
+  },
   "dependencies": {
     "nanoid": "^5.0.6",
     "zod": "^3.22.4"