create-asyra-design-app
v0.5.12
Published
Create a ready-to-use Asyra Design canvas and visual editor app
Maintainers
Readme
create-asyra-design-app
Create an immediately editable Asyra Design product from the official standalone template. This is the product-first entrance when you want a complete design tool you can use, study, and continue building directly or with an AI coding agent.
Requirements:
- Node.js 24.x
- Yarn, npm, or pnpm
Create a project
npx create-asyra-design-app my-productThe CLI asks which supported package manager to use, copies the verified template into one new directory, creates its package-manager files, and installs dependencies.
For automation, select the package manager explicitly:
npx create-asyra-design-app my-product --package-manager=yarn
npx create-asyra-design-app my-product --package-manager=npm
npx create-asyra-design-app my-product --package-manager=pnpmBoth --package-manager=value and --package-manager value are supported.
Project names must be one new directory name; absolute paths, ./.., nested
paths, and existing targets are rejected.
Start editing
cd my-product
yarn startFor npm or pnpm, use the exact start command printed by the CLI:
npm run start
pnpm startOpen:
http://localhost:3000/?fileId=my-designThe non-empty fileId is the App document and collaboration-room identity.
The generated frontend remains locally editable when its reference socket
service is unavailable, but that disconnected path is not durable backend
persistence or multi-Actor collaboration.
Run the complete local services
Start these in separate terminals:
yarn document:backendyarn collaboration:serveryarn startUse npm run <script> or pnpm <script> for the selected package manager. The
generated environment points the browser to the local reference socket service
and the socket server to the local document backend. Opening the same fileId
in two windows exercises the complete checkpoint, live publication, and
durability path.
Production authentication, authorization, backup, retention, custom domain rules, and service topology remain App/backend responsibilities.
Continue with Asyra
The generated project is normal source code. Start with one bounded App-owned extension, keep its domain rules out of Framework packages, route mutations through Features and public APIs, add tests, and then expand the product.
- Generated-product walkthrough
- Extend with an AI coding agent
- Framework learning guides
- Advanced implementation guides
- Complete public documentation
- Asyra Design case study
create-asyra-design-app teaches how a real product uses Asyra. The Framework
documentation and Runtime Atlas remain a separate entrance for learning Core,
Preset, transactions, schemas, custom rendering, collaboration, and registered
AI actions without first understanding the full product stack.
Verify
Run the standalone gates after an extension:
yarn typecheck
yarn react:build
yarn testWith the complete services running:
yarn test:e2e
yarn test:e2e:collaborationUse the equivalent npm or pnpm script command when that manager was selected.
Generated project contract
apps/asyra-designis the canonical Asyra Design product source.apps/asyra-design/README.mdis the canonical generated README source.- the official generator materializes
create-app/asyra-design/template; generated output receives no handwritten product fixes. - Framework dependency versions are resolved from the reviewed release manifests, and generated code uses declared public entrypoints only.
- Framework owns deterministic mechanics, Preset owns optional official defaults, the generated App owns product/domain behavior, and App services own transport, authorization, durability, and model-provider policy.
The generated project supports the current browser/Core composition, official
Preset 2D, and engine-neutral CUSTOM extension boundary. Public Headless
Core, Core Kernel, production 3D/HYBRID, auto-layout, and unit-aware
aggregation are future work.
Support and contribution policy
This repository does not accept external issues or contributions, including pull requests. You may use and fork the CLI and generated product under the MIT License. Follow the upstream security policy for security-sensitive reports and the release support contract for current runtime and package boundaries.
