mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
Vance Ingalls
6e01980f41
The command starts a preview server — "preview" describes what users are doing more accurately than "dev". Updates the command name, file name, all CLI references, docs, skills, and template CLAUDE.md. 22 files updated across CLI source, docs, skills, and templates. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# @hyperframes/studio
|
|
|
|
Browser-based composition editor UI for Hyperframes. Provides a visual timeline, code editor, and live preview for building video compositions.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install @hyperframes/studio
|
|
```
|
|
|
|
## What it does
|
|
|
|
The studio is a React application with:
|
|
|
|
- **Visual timeline** — drag, resize, and arrange elements on tracks
|
|
- **Code editor** — edit HTML and GSAP scripts with CodeMirror (syntax highlighting, autocomplete)
|
|
- **Live preview** — see changes in real time as you edit
|
|
- **Composition inspector** — view and modify element properties
|
|
|
|
## Development
|
|
|
|
The studio is embedded in the `hyperframes preview` command. To develop the studio UI itself:
|
|
|
|
```bash
|
|
cd packages/studio
|
|
bun run dev # Start Vite dev server
|
|
bun run build # Build for production
|
|
bun run typecheck # Type-check
|
|
```
|
|
|
|
## Tech stack
|
|
|
|
- React 18/19, Zustand (state management)
|
|
- CodeMirror 6 (editor)
|
|
- Tailwind CSS (styling)
|
|
- Vite (bundler)
|
|
- Phosphor Icons
|
|
|
|
## Documentation
|
|
|
|
Full documentation: [hyperframes.heygen.com/packages/studio](https://hyperframes.heygen.com/packages/studio)
|
|
|
|
## Related packages
|
|
|
|
- [`@hyperframes/core`](../core) — types and parsers used by the editor
|
|
- [`hyperframes`](../cli) — CLI that serves the studio via `hyperframes preview`
|