@lerret/cli 0.1.0 → 0.1.1
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 +49 -0
- package/dist-studio/.bundle-stamp +1 -1
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# lerret
|
|
2
|
+
|
|
3
|
+
> An open-source design canvas where a folder of plain React component files renders as a visual canvas.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@lerret/cli)
|
|
6
|
+
[](https://github.com/belikely-united/lerret/blob/main/LICENSE)
|
|
7
|
+
|
|
8
|
+
Lerret turns a folder of `.jsx`/`.tsx` components into a live, navigable canvas — pan-and-zoom artboards, sub-second hot reload on save, and headless export to image files. No proprietary format, no backend, no account required.
|
|
9
|
+
|
|
10
|
+
## Quick start
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
npx create-lerret my-canvas
|
|
14
|
+
cd my-canvas
|
|
15
|
+
npx @lerret/cli dev
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
The studio opens in your browser. Save any `.jsx` file under `.lerret/` and the canvas re-renders.
|
|
19
|
+
|
|
20
|
+
## What's in the package
|
|
21
|
+
|
|
22
|
+
This package ships the `lerret` binary:
|
|
23
|
+
|
|
24
|
+
- `lerret dev` — run the studio against a `.lerret/` folder (Vite dev server + bundled studio).
|
|
25
|
+
- `lerret export` — headlessly render a project (or page/group) to image files.
|
|
26
|
+
|
|
27
|
+
After installing globally (`npm install -g @lerret/cli`), the command is just `lerret`.
|
|
28
|
+
|
|
29
|
+
## Requirements
|
|
30
|
+
|
|
31
|
+
- Node.js ≥ 20.19
|
|
32
|
+
- A Chromium-based browser (Chrome, Edge, Brave, Arc) for the studio. The CLI itself works anywhere Node runs.
|
|
33
|
+
|
|
34
|
+
## Documentation
|
|
35
|
+
|
|
36
|
+
Full docs: **https://lerret-docs.web.app** *(custom domain `docs.lerret.belikely.com` coming soon)*
|
|
37
|
+
|
|
38
|
+
- [Getting Started](https://lerret-docs.web.app/getting-started/)
|
|
39
|
+
- [Concepts — the folder-canvas model](https://lerret-docs.web.app/concepts/)
|
|
40
|
+
- [Authoring Assets](https://lerret-docs.web.app/authoring/)
|
|
41
|
+
- [CLI Reference](https://lerret-docs.web.app/cli/)
|
|
42
|
+
|
|
43
|
+
## Source
|
|
44
|
+
|
|
45
|
+
[github.com/belikely-united/lerret](https://github.com/belikely-united/lerret) — issues, discussions, contributions welcome.
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
[MIT](https://github.com/belikely-united/lerret/blob/main/LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lerret/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "The `lerret` design canvas CLI — a folder of plain React component files renders as a visual canvas. Includes the Vite dev server, headless export, and the bundled studio.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"chokidar": "^5.0.0",
|
|
40
40
|
"playwright-core": "^1.60.0",
|
|
41
41
|
"vite": "^8.0.0",
|
|
42
|
-
"@lerret/core": "^0.1.
|
|
42
|
+
"@lerret/core": "^0.1.1"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"vitest": "^4.1.6"
|