maxGraph integration examples

Demonstrate how to integrate maxGraph in projects.

⏩ Find the live demo at https://maxgraph.github.io/maxgraph-integration-examples/

Getting started

Setup

Ensure you are using Node 18 (this is the tested version, it may work with other versions without guarantee)

If you are using nvm, run

nvm use

If the Node version is not installed, nvm will state how to install the required version.

Install dependencies by running

npm install

Build the "shared" package:

• this package is used in all projects, so it must be built first.
• for more details, see its dedicated README.

Available projects

• TypeScript with Lit
• TypeScript with Parcel
• TypeScript with Rollup
• TypeScript with Rsbuild
• TypeScript with SvelteKit
• TypeScript with ViteJs

Use the maxGraph development version

Note: the maxGraph development version is tested in a GitHub Workflow that uses the procedure explained below.

Build maxGraph locally:

• from the maxGraph project root, run: npm install
• then, from the packages/core folder, run: npm pack
• the packages/core folder or the generated packages/core/maxgraph-core-***.tgz file are now ready for use in an external project

In this folder where you clone the maxgraph-integration-examples project, go to the folder of the example you want to use. Then you can use one of the following solution

• with npm link: npm link <path_to_locally_installed_maxgraph>/packages/core: create a soft link to the maxgraph local folder. Repack of maxgraph is automatically available in the examples
• alternative: npm install <path_to_locally_installed_maxgraph>/packages/core/maxgraph-core-0.1.0.tgz. This changes the package.json file. You must run this command again each time you rebuild the maxgraph npm package.

Release

The versioning in this repository follow the versioning of maxGraph. For example, version 0.5.0 uses maxGraph 0.5.0.

So, prior releasing a new version of this version, the maxGraph version must have been updated:

• Dependencies in this repository are automatically updated by Dependabot, so you can trigger a new Dependabot run or wait for the next scheduled Dependabot run for this update to take place.
• Validate that the examples work: use the artifact built by GitHub Actions to test the various applications locally.

Once maxGraph has been updated, the release can be done by running the release workflow which:

• creates the Git tag
• publishes a GitHub release including the automatically generated release notes.