|
1 | | -# @knighted/develop |
| 1 | +# <img src="src/logo.svg" alt="@knighted/develop logo" width="36" height="36" style="vertical-align: middle;" /> <span style="vertical-align: middle;"><code>@knighted/develop</code></span> |
2 | 2 |
|
3 | | -Compiler-as-a-Service (at the edge of your browser) with `@knighted/jsx` and `@knighted/css`. |
| 3 | +CDN-first browser IDE for building UI components with [`@knighted/jsx`](https://github.com/knightedcodemonkey/jsx) and [`@knighted/css`](https://github.com/knightedcodemonkey/css). |
4 | 4 |
|
5 | | -> ⚠️ Early project status: this package is pre-`1.0.0` and still actively evolving. |
| 5 | + |
6 | 6 |
|
7 | 7 | ## What it is |
8 | 8 |
|
9 | | -`@knighted/develop` is a lightweight dev app that lets you: |
| 9 | +`@knighted/develop` is a browser-native IDE that demonstrates modern component |
| 10 | +authoring without a local bundler-first inner loop. |
10 | 11 |
|
11 | | -- write component code in the browser |
12 | | -- switch render mode between DOM and React |
13 | | -- switch style mode between native CSS, CSS Modules, Less, and Sass |
14 | | -- preview results immediately |
15 | | - |
16 | | -## Local development |
17 | | - |
18 | | -```bash |
19 | | -npm install |
20 | | -npm run dev |
21 | | -``` |
22 | | - |
23 | | -Then open the URL printed by the dev server (it should open `src/index.html`). |
24 | | - |
25 | | -## End-to-end tests |
| 12 | +The app is designed to showcase two libraries: |
26 | 13 |
|
27 | | -Install Playwright browsers once before your first local run: |
| 14 | +- [`@knighted/jsx`](https://github.com/knightedcodemonkey/jsx) for DOM-first and React-mode JSX authoring |
| 15 | +- [`@knighted/css`](https://github.com/knightedcodemonkey/css) for in-browser CSS compilation workflows |
28 | 16 |
|
29 | | -```bash |
30 | | -npx playwright install |
31 | | -``` |
| 17 | +Dependencies are delivered over CDN ESM with on-demand loading by mode, so the |
| 18 | +browser acts as the runtime host for render, lint, and typecheck flows. |
32 | 19 |
|
33 | | -If your environment needs system dependencies too (for example Linux CI-like containers), use: |
| 20 | +## Core capabilities |
34 | 21 |
|
35 | | -```bash |
36 | | -npx playwright install --with-deps |
37 | | -``` |
| 22 | +`@knighted/develop` lets you: |
38 | 23 |
|
39 | | -Run local Playwright tests (Chromium): |
40 | | - |
41 | | -```bash |
42 | | -npm run test:e2e |
43 | | -``` |
44 | | - |
45 | | -Run locally with headed browser: |
46 | | - |
47 | | -```bash |
48 | | -npm run test:e2e:headed |
49 | | -``` |
50 | | - |
51 | | -CI runs Playwright on Chromium and WebKit. |
| 24 | +- write component code in the browser |
| 25 | +- switch render mode between DOM and React |
| 26 | +- switch style mode between native CSS, CSS Modules, Less, and Sass |
| 27 | +- run in-browser lint and type diagnostics |
| 28 | +- open diagnostics in a shared drawer and jump to source locations |
| 29 | +- toggle ShadowRoot preview isolation while iterating |
| 30 | +- switch layout and theme while preserving fast feedback loops |
52 | 31 |
|
53 | | -## Notes |
| 32 | +## Try it |
54 | 33 |
|
55 | | -- This is currently a development playground, not a stable product. |
56 | | -- Expect breaking changes while APIs and UX are still being shaped. |
57 | | -- Documentation will expand closer to `1.0.0`. |
| 34 | +- Live IDE: https://knightedcodemonkey.github.io/develop/ |
| 35 | +- Source repository: https://github.com/knightedcodemonkey/develop |
58 | 36 |
|
59 | 37 | ## License |
60 | 38 |
|
|
0 commit comments