Skip to content

Fix contributor guide setup details #1875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alan747271363-art wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

Fix contributor guide setup details #1875

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Cap is an open source and privacy focused alternative to Loom. It's a video messaging tool that allows you to record, edit and share videos in seconds.

The development of Cap is still in its early stages, so please bare with us as we build out this guide.
The development of Cap is still in its early stages, so please bear with us as we build out this guide.

### What is this guide?

Expand All @@ -20,23 +20,23 @@ 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.

On Windows, llvm, clang, and VCPKG must be installed.
On MacOS, cmake 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.
Expand All @@ -61,4 +61,4 @@ and `%programfiles%/so.cap.desktop.dev/recordings` on Windows.
### `@cap/web` (cap.so website)

When running `pnpm dev` or `pnpm dev:web`, a MySQL database and MinIO S3 server will also be using Docker.
If you want to _only_ run the `@cap/web` NextJS app, `cd` into `./apps/web` and run `pnpm dev`.
If you want to _only_ run the `@cap/web` Next.js app, `cd` into `./apps/web` and run `pnpm dev`.