Skip to content

Getting started

Vyuh Diagram is a Flutter drawing framework under active development. Its packages currently use publish_to: none; these instructions use the repository workspace, not a published pub.dev release.

Run the demo

Use a Flutter SDK satisfying the workspace's Dart ^3.13.0 and kit's Flutter >=3.47.0 constraints. From the repository root:

sh
flutter pub get
cd apps/demo
flutter run -d chrome

To produce a release web build:

sh
cd apps/demo
flutter build web --release --wasm

Run each command block from the repository root. Serve the resulting apps/demo/build/web directory through an HTTP server; opening index.html as a local file is not equivalent to running the application.

Add an app inside this workspace

Create a Flutter app, add its directory to the root workspace list, and configure its pubspec with workspace resolution:

yaml
name: my_diagram_app
publish_to: none
resolution: workspace

environment:
  sdk: ^3.13.0
  flutter: '>=3.47.0'

dependencies:
  flutter:
    sdk: flutter
  vyuh_diagram_kit: ^0.1.0

Run flutter pub get from the workspace root. Pub resolves the local kit and its sibling packages together. This is a workspace dependency example; copying it into an unrelated repository does not install the unpublished packages. External repository packaging and release distribution need a separate integration setup.

Choose your starting point

The framework targets responsive interaction on high refresh rate displays. A release Wasm build is available as a build target, but it does not establish a universal 120 fps guarantee.