https://github.com/capsoftware/cap
Open source Loom alternative. Beautiful, shareable screen recordings.
https://github.com/capsoftware/cap
app cap coss loom mac nextjs nextjs14 open-source oss react record screen-capture screen-recorder screenshot solidjs tauri tauri-app typescript vite
Last synced: 27 days ago
JSON representation
Open source Loom alternative. Beautiful, shareable screen recordings.
- Host: GitHub
- URL: https://github.com/capsoftware/cap
- Owner: CapSoftware
- License: agpl-3.0
- Created: 2023-11-17T20:31:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T12:02:01.000Z (9 months ago)
- Last Synced: 2025-05-08T12:23:28.232Z (9 months ago)
- Topics: app, cap, coss, loom, mac, nextjs, nextjs14, open-source, oss, react, record, screen-capture, screen-recorder, screenshot, solidjs, tauri, tauri-app, typescript, vite
- Language: TypeScript
- Homepage: https://cap.so
- Size: 211 MB
- Stars: 9,196
- Watchers: 33
- Forks: 497
- Open Issues: 122
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Cap
The open source Loom alternative.
Cap.so »
Downloads for
macOS & Windows
[](https://console.algora.io/org/CapSoftware/bounties?status=open)
Cap is the open source alternative to Loom. It's a video messaging tool that allows you to record, edit and share videos in seconds.
# Self Hosting
Cap Web is available to self-host using Docker or Railway, see our [self-hosting docs](https://cap.so/docs/self-hosting) to learn more.
You can also use the button below to deploy Cap Web to Railway:
[](https://railway.com/new/template/PwpGcf)
Cap Desktop can connect to your self-hosted Cap Web instance regardless of if you build it yourself or [download from our website](https://cap.so/download).
# Monorepo App Architecture
We use a combination of Rust, React (Next.js), TypeScript, Tauri, Drizzle (ORM), MySQL, TailwindCSS throughout this Turborepo powered monorepo.
> A note about database: The codebase is currently designed to work with MySQL only. MariaDB or other compatible databases might partially work but are not officially supported.
### Apps:
- `desktop`: A [Tauri](https://tauri.app) (Rust) app, using [SolidStart](https://start.solidjs.com) on the frontend.
- `web`: A [Next.js](https://nextjs.org) web app.
### Packages:
- `ui`: A [React](https://reactjs.org) Shared component library.
- `utils`: A [React](https://reactjs.org) Shared utility library.
- `tsconfig`: Shared `tsconfig` configurations used throughout the monorepo.
- `database`: A [React](https://reactjs.org) and [Drizzle ORM](https://orm.drizzle.team/) Shared database library.
- `config`: `eslint` configurations (includes `eslint-config-next`, `eslint-config-prettier` other configs used throughout the monorepo).
### License:
Portions of this software are licensed as follows:
- All code residing in the `cap-camera*` and `scap-*` families of crates is licensed under the MIT License (see [licenses/LICENSE-MIT](https://github.com/CapSoftware/Cap/blob/main/licenses/LICENSE-MIT)).
- All third party components are licensed under the original license provided by the owner of the applicable component
- All other content not mentioned above is available under the AGPLv3 license as defined in [LICENSE](https://github.com/CapSoftware/Cap/blob/main/LICENSE)
# Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. This guide is a work in progress, and is updated regularly as the app matures.
## Analytics (Tinybird)
Cap uses [Tinybird](https://www.tinybird.co) to ingest viewer telemetry for dashboards. The Tinybird admin token (`TINYBIRD_ADMIN_TOKEN` or `TINYBIRD_TOKEN`) must be available in your environment. Once the token is present you can:
- Provision the required data sources and materialized views via `pnpm analytics:setup`. This command installs the Tinybird CLI (if needed), runs `tb login` when a `.tinyb` credential file is missing, copies that credential into `scripts/analytics/tinybird`, and finally executes `tb deploy --allow-destructive-operations --wait` from that directory. **It synchronizes the Tinybird workspace to the resources defined in `scripts/analytics/tinybird`, removing any other datasources/pipes in that workspace.**
- Validate that the schema and materialized views match what the app expects via `pnpm analytics:check`.
Both commands target the workspace pointed to by `TINYBIRD_HOST` (defaults to `https://api.tinybird.co`). Make sure you are comfortable with the destructive nature of the deploy step before running `analytics:setup`.