Conclave

Real-time meetings platform with web and native clients, an SFU, and an apps SDK

---

Table of Contents

• About
• Monorepo Layout
• Quick Start
• Mobile Development
• Apps SDK Docs
• Optional Services
• Contributing
• Community & Conduct

---

About

Conclave is a real-time meetings platform with:

• apps/web: Next.js web client and API routes
• apps/conclave-skip: active SwiftUI/Skip project for iOS and Android
• apps/mobile: deprecated Expo client; do not use for new work
• packages/sfu: mediasoup SFU and real-time socket handlers
• packages/apps-sdk: web in-meeting apps runtime (provider, Yjs sync, and awareness)
• packages/shared-browser: optional VNC-based shared browser service

---

Monorepo Layout

apps/
  web/
  conclave-skip/
packages/
  sfu/
  apps-sdk/
  shared-browser/
scripts/

Prerequisites:

• Node.js 20+
• pnpm 11.7.0
• Swift and Xcode for native development
• Docker (optional, for deploy scripts and shared browser runtime image)

---

Quick Start

1. Install dependencies:

pnpm install

2. Start SFU:

pnpm -C packages/sfu run dev

3. Start web in another terminal:

pnpm -C apps/web run dev

4. Open http://localhost:3000.

Notes:

• Web defaults to https://sfu.acmvit.in if SFU_URL/NEXT_PUBLIC_SFU_URL is unset.
• SFU has development defaults; production must set secrets and announced IPs.

---

Mobile Development

The active native application is apps/conclave-skip. It shares SwiftUI source between iOS and Android through Skip.

cd apps/conclave-skip
swift build
swift test -q

See apps/conclave-skip/README.md for Android and iOS build commands. apps/mobile is deprecated and excluded from the workspace.

---

Apps SDK Docs

• package README: packages/apps-sdk/README.md
• docs home: packages/apps-sdk/docs/README.md
• add app integration: packages/apps-sdk/docs/guides/add-a-new-app-integration.md
• app cookbook: packages/apps-sdk/docs/guides/app-cookbook.md
• troubleshooting: packages/apps-sdk/docs/guides/troubleshooting.md

Contributor commands:

pnpm -C packages/apps-sdk run new:app polls
pnpm -C packages/apps-sdk run check:apps
pnpm -C packages/apps-sdk run check:apps:fix

---

Optional Services

Run shared browser service locally:

pnpm -C packages/shared-browser run dev

Deploy SFU pair (Docker Compose):

./scripts/deploy-sfu.sh

Deploy shared browser service (Docker Compose):

./scripts/deploy-browser-service.sh

---

Contributing

Read CONTRIBUTING.md before opening a PR.

---

Community & Conduct

By participating in this project, you agree to follow CODE_OF_CONDUCT.md.

---

🤍 Crafted with love by ACM-VIT