From 47b79bb673bea1fac8922acab75170540e22c264 Mon Sep 17 00:00:00 2001 From: archit-goyal Date: Fri, 19 Jun 2026 15:00:54 +0530 Subject: [PATCH] chore: align contributor setup docs --- CONTRIBUTING.md | 14 +++++++------- package.json | 7 ------- pnpm-workspace.yaml | 4 ++++ 3 files changed, 11 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca0b11624b3..c9aaddedc06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ There are many ways to contribute to Cap. You can: - [Suggest a feature (via Discord)](https://discord.com/invite/y8gdQ3WRN3) - Submit a PR -## Runing Cap +## Running Cap ### Development Requirements @@ -28,21 +28,21 @@ Before anything else, make sure you have the following installed: - Node Version 20+ - Rust 1.88.0+ -- pnpm 8.10.5+ +- pnpm 10.5.2 - Docker ([OrbStack](https://orbstack.dev/) recommended) ### General Setup -Run `pnpm install`, then run `pnpm cap-setup` to install native dependencies such as FFmpeg. +Run `pnpm install`, then run `pnpm env-setup` to generate a `.env` file configured for your environment. +It will ask you which apps you intend to run, whether you'd like to use Docker to run S3 (MinIO) and MySQL locally, +and allow you to provide overrides as needed. + +Then run `pnpm cap-setup` to install native dependencies such as FFmpeg. On Windows, llvm, clang, and VCPKG must be installed. On MacOS, cmake must be installed. `pnpm cap-setup` does not yet install these dependencies for you. -Run `pnpm env-setup` to generate a `.env` file configured for your environment. -It will ask you which apps you intend to run, whether you'd like to use Docker to run S3 (MinIO) and MySQL locally, -and allow you to provide overrides as needed. - To run both `@cap/desktop` and `@cap/web` together, use `pnpm dev`. To run only one of them, use `pnpm dev:desktop` or `pnpm dev:web` respectively. diff --git a/package.json b/package.json index 29d347173e3..88710d8a78d 100644 --- a/package.json +++ b/package.json @@ -59,13 +59,6 @@ "turbo": "^2.3.4", "typescript": "^5.8.3" }, - "pnpm": { - "peerDependencyRules": { - "allowedVersions": { - "next-auth>next": ">=16.0.0" - } - } - }, "packageManager": "pnpm@10.5.2", "name": "cap", "engines": { diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 614993f77eb..4e721379fd7 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -4,3 +4,7 @@ packages: - "crates/tauri-plugin-*" - "infra" - "scripts/orgIdBackfill" + +peerDependencyRules: + allowedVersions: + next-auth>next: ">=16.0.0"