melies-video-editor 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,44 +1,44 @@
1
- # Video Editor GUI (React)
2
-
3
- This repo builds and publishes a reusable React video timeline editor GUI.
4
-
5
- **Upstream credit:** The timeline editor UI and data model are built on top of **@xzdarcy/react-timeline-editor** (MIT License) by **zdarcy**.
6
- - NPM: https://www.npmjs.com/package/@xzdarcy/react-timeline-editor
7
- - License: MIT (see the upstream package for the full text)
8
-
9
- This project is not affiliated with the upstream author.
10
-
11
- ## Local development
12
-
13
- - Start the UI (demo app): `pnpm dev`
14
-
15
- ### Dev host wrapper (simulate embedding)
16
-
17
- By default, `pnpm dev` runs the standalone editor view.
18
-
19
- To run the dev host wrapper app (header/sidebar + editor), set:
20
-
21
- - `VITE_DEV_HOST_APP=1`
22
-
23
- Example (PowerShell):
24
-
25
- - `$env:VITE_DEV_HOST_APP = "1"; pnpm dev`
26
-
27
- Or create a `.env.local` file in the repo root:
28
-
29
- - `VITE_DEV_HOST_APP=1`
30
-
31
- ## Build (library)
32
-
33
- - Build the npm package output into `dist/`: `pnpm build`
34
-
35
- ## Export server (local-only)
36
-
37
- This repo also contains a simple Express + ffmpeg export server used for local development.
38
-
39
- - Start the export server (separate terminal): `pnpm dev:server`
40
-
41
- Notes:
42
- - Requires `ffmpeg` available on `PATH` (or set `FFMPEG_PATH`).
43
- - Vite dev server proxies `/export` to `http://localhost:5174` (see `vite.config.ts`).
44
- - The `server/` folder is **not** included in the published npm package.
1
+ # Video Editor GUI (React)
2
+
3
+ This repo builds and publishes a reusable React video timeline editor GUI.
4
+
5
+ **Upstream credit:** The timeline editor UI and data model are built on top of **@xzdarcy/react-timeline-editor** (MIT License) by **zdarcy**.
6
+ - NPM: https://www.npmjs.com/package/@xzdarcy/react-timeline-editor
7
+ - License: MIT (see the upstream package for the full text)
8
+
9
+ This project is not affiliated with the upstream author.
10
+
11
+ ## Local development
12
+
13
+ - Start the UI (demo app): `pnpm dev`
14
+
15
+ ### Dev host wrapper (simulate embedding)
16
+
17
+ By default, `pnpm dev` runs the standalone editor view.
18
+
19
+ To run the dev host wrapper app (header/sidebar + editor), set:
20
+
21
+ - `VITE_DEV_HOST_APP=1`
22
+
23
+ Example (PowerShell):
24
+
25
+ - `$env:VITE_DEV_HOST_APP = "1"; pnpm dev`
26
+
27
+ Or create a `.env.local` file in the repo root:
28
+
29
+ - `VITE_DEV_HOST_APP=1`
30
+
31
+ ## Build (library)
32
+
33
+ - Build the npm package output into `dist/`: `pnpm build`
34
+
35
+ ## Export server (local-only)
36
+
37
+ This repo also contains a simple Express + ffmpeg export server used for local development.
38
+
39
+ - Start the export server (separate terminal): `pnpm dev:server`
40
+
41
+ Notes:
42
+ - Requires `ffmpeg` available on `PATH` (or set `FFMPEG_PATH`).
43
+ - Vite dev server proxies `/export` to `http://localhost:5174` (see `vite.config.ts`).
44
+ - The `server/` folder is **not** included in the published npm package.