mirror of
https://github.com/digitalsamba/claude-code-video-toolkit.git
synced 2026-09-18 19:41:13 +08:00
8ef3fcc517
Make it clear that videos render with just Node.js installed. Reorganize .env.example with commented-out defaults, add "Try It Now" quick start pointing to hello-world example, and replace terse API key errors in all Python tools with actionable guidance (add key, use alternative, or skip). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Example Projects
Curated showcase projects demonstrating toolkit capabilities.
Available Examples
| Example | Template | Contributor | Description | Complexity |
|---|---|---|---|---|
| hello-world | sprint-review | — | Minimal 25s video — zero config, renders in 2 minutes | Beginner |
| digital-samba-skill-demo | product-demo | Digital Samba | Marketing video for Claude Code skill | Intermediate |
| sprint-review-cho-oyu | sprint-review | Digital Samba | iOS sprint review for Digital Samba Mobile | Intermediate |
Note: Examples include configs and documentation, but NOT large media files. See each example's
ASSETS-NEEDED.mdfor what to create.
Contributors
Thank you to these organizations and individuals for sharing their video projects:
| Contributor | Website | Examples Shared |
|---|---|---|
| Digital Samba | digitalsamba.com | digital-samba-skill-demo, sprint-review-cho-oyu |
Want your project featured? Run /contribute and select "Share an example project".
Using Examples
# Copy an example to your projects directory
cp -r examples/example-name projects/my-project
cd projects/my-project
# Install and preview
npm install
npm run studio
Adding Demo Assets
Examples don't include large media files (videos, audio). To run them:
- Record demos - Use
/record-demoto capture screen recordings - Generate voiceover - Use
/generate-voiceoverwith the included script - Add music - Use
python tools/music.pyfor background tracks
Each example includes a ASSETS-NEEDED.md documenting what to create.
Contributing Examples
To share a project as an example:
- Run
/contributeand select "Share a template" (examples work similarly) - Or manually:
# Copy project to examples (without large media)
cp -r projects/my-project examples/
# Remove media files (these are gitignored anyway)
rm examples/my-project/public/demos/*.mp4
rm examples/my-project/public/audio/*.mp3
# Create asset documentation
# (describe what demos/audio are needed)
# Commit and PR
git add examples/my-project
git commit -m "Add example: my-project"
gh pr create
Example Structure
examples/example-name/
├── README.md # What this example demonstrates
├── ASSETS-NEEDED.md # What media to create
├── src/
│ └── config/
│ └── *-config.ts # Example configuration
├── public/
│ ├── demos/ # Empty (add your recordings)
│ ├── audio/ # Empty (add your voiceover)
│ └── images/ # Logos, screenshots (tracked)
└── VOICEOVER-SCRIPT.md # Script for narration