Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,29 @@ 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

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.

Expand Down
7 changes: 0 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
4 changes: 4 additions & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ packages:
- "crates/tauri-plugin-*"
- "infra"
- "scripts/orgIdBackfill"

peerDependencyRules:
allowedVersions:
next-auth>next: ">=16.0.0"