Architecture and contributing

interactive-demo is MIT licensed and developed in the open at github.com/inkly-ai/interactive-demo. Pull requests are welcome. The repo is an npm workspace with three packages:

Package	What it owns
`packages/runtime`	The React player, the demo schema, and the theme. Published as `@inkly-org/interactive-demo`.
`packages/cli`	The `interactive-demo` command. Published as `@inkly-org/interactive-demo-cli`.
`packages/editor`	The local editor. Not published on its own. It is built into the CLI and served by `dev`.

The contributor documentation lives in the repo, next to the code it describes.

Architecture

What each package is responsible for, the build graph, the testbed, and the checks a change has to pass.

Contributing

How to propose a change, the commit style, and the sign-off the project uses.

Run it from source

git clone https://github.com/inkly-ai/interactive-demo.git
cd interactive-demo
npm install
npm run build && npm run typecheck && npm run lint && npm test

Found a bug or want a feature? Open an issue.

Get started

Make a demo

Ship it

Reference

Architecture and contributing

Architecture

Contributing

Run it from source

Architecture

Contributing

​Run it from source

Run it from source