Demo apps

JointJS+ comes with a wide range of demo applications including their full source code. You can use them to learn the framework, as a starting point for your own projects, or as boilerplate applications.

All demo apps are available in our public GitHub repository: github.com/clientIO/joint-demos.

Browsing available demos

Use the @joint/cli tool to list all available demos:

npx @joint/cli list

Each demo is identified by a name/variant path, for example kitchen-sink/react-ts or database/js.

Downloading a demo

To download a demo into your current working directory:

npm

npx @joint/cli download kitchen-sink/react-ts

Global install

npm install -g @joint/cli
joint download kitchen-sink/react-ts

This creates a kitchen-sink-react-ts/ folder with the full source code.

You can also specify a custom destination folder:

npx @joint/cli download kitchen-sink/react-ts my-app

To download into the current directory (must be empty or use --force):

npx @joint/cli download kitchen-sink/react-ts .

Running a demo

After downloading, follow the instructions in the demo's README.md:

cd kitchen-sink-react-ts
npm install
npm start

tip

JointJS+ demos require access to the @joint/plus package. Make sure you have configured the npm registry before running npm install.

Working with forks

Use the --owner and --branch options to list and download examples from a fork of the demos repository:

npx @joint/cli list --owner myGitHubUser
npx @joint/cli download kitchen-sink/js --owner myGitHubUser --branch dev