Skip to content

Commit

Permalink
Merge pull request #218 from CapSoftware/omar/add-drizzle-studio
Browse files Browse the repository at this point in the history
contributing: Drizzle Studio + Docs update
  • Loading branch information
richiemcilroy authored Dec 19, 2024
2 parents a1ac1ef + f3abd42 commit ab3c4ef
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ There are many ways to contribute to Cap. You can:
- Cargo 1.77.0+ (previous versions may work)
- pnpm 8.10.5+
- Docker ([OrbStack](https://orbstack.dev/) recommended)
- pkg-config

### How do I get started with development on my local machine?

Expand All @@ -40,6 +41,9 @@ This is a very top level guide right now, but if you want to develop for both th
5. Make sure both the the desktop app, and web app can be built without any errors. For the desktop app, use `pnpm tauri:build`. For the web app, use `pnpm build`
6. Submit a PR with your changes

> [!NOTE]
> When running the app locally on a MacOS machine, you will need to give permissions to Cap - this will show up as your **Terminal app** in the Security & Privacy settings page.
### How do I run the desktop app locally without needing to use auth?

You can run cap in "local mode", which means that no auth is required for the desktop app, and no video segments are uploaded. Similar to the above steps, this is how you can run the Cap desktop app in local mode with the least amount of .env vars.
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"format": "prettier --write \"**/*.{ts,tsx,md}\"",
"db:push": "dotenv -e .env -- pnpm --dir packages/database db:push",
"db:generate": "dotenv -e .env -- pnpm --dir packages/database db:generate",
"db:studio": "dotenv -e .env -- pnpm --dir packages/database db:studio",
"tauri:build": "dotenv -e .env -- pnpm --dir apps/desktop tauri build --verbose",
"typecheck": "pnpm tsc -b"
},
Expand All @@ -29,4 +30,4 @@
"@kobalte/[email protected]": "patches/@[email protected]"
}
}
}
}
5 changes: 3 additions & 2 deletions packages/database/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"db:push": "drizzle-kit push:mysql --config=drizzle.config.ts",
"db:check": "drizzle-kit check:mysql --config=drizzle.config.ts",
"db:up": "drizzle-kit up:mysql --config=drizzle.config.ts",
"db:drop": "drizzle-kit drop --config=drizzle.config.ts"
"db:drop": "drizzle-kit drop --config=drizzle.config.ts",
"db:studio": "drizzle-kit studio --config=drizzle.config.ts"
},
"dependencies": {
"@mattrax/mysql-planetscale": "^0.0.3",
Expand Down Expand Up @@ -41,4 +42,4 @@
"engines": {
"node": "20"
}
}
}

1 comment on commit ab3c4ef

@vercel
Copy link

@vercel vercel bot commented on ab3c4ef Dec 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.