How webav-tech/webav works
Project type and purpose
• This is a monorepo for an open-source WebAV SDK: a collection of npm packages for client-side audio/video processing (av-cliper, av-canvas, av-recorder, internal-utils) plus a documentation/demo site (doc-site).
• Its purpose is to provide high-performance, browser-native video editing/recording capabilities built on WebCodecs, WebAudio, Canvas, and to deliver demos and API docs via a static site.
File structure
• Top-level:
• pnpm-workspace.yaml + package.json + tsconfig.json → workspace root & shared TS config
• .github/workflows → CI for testing, building, releasing, doc-site deploy
• scripts → commit verification
• packages/… → four separate modules:
– av-cliper: core audio/video data processing
– av-canvas: interactive canvas UI on top of av-cliper
– av-recorder: media stream recorder
– internal-utils: shared helpers (logging, event, stream utils)
• doc-site/ → Dumi-based documentation and demo site
• Each package has src/, __tests__/, demo/, vite.config.ts, tsconfig.json, package.json.
• CHANGELOG.md, LICENSE, README files at root and per package.
Insights from README
• Describes features (cross-platform, zero server cost, high performance) and use-cases (batch processing, live streaming, editing).
• Highlights core APIs in av-cliper (IClip, Sprite, Combinator), av-canvas (AVCanvas), av-recorder (AVRecorder).
• Guides on development workflow (pnpm install, build, run demos, tests).
Elements
• Clear labels for each component (module names, doc-site, CI, external services)
• Rectangles for code modules
• Hexagons for CI/CD
• Shadows or grouping for workspace boundaries
Final guidance
• Every essential element: repo root, workspace config, individual package layers, docs site, CI pipeline, external integrations, developer and consumer roles.
• Use a modular layout—left side for source modules, right side for consumers and deployment, bottom for CI/CD.