bpmn-visualization-demo-template

A template repository to quickly initiate a bpmn-visualization demo

🤔 Using the template

Create your repository based on this repository template: see https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
Update the repository settings
- GitHub pages: enable Build and deployment with Source GitHub Actions
- Dependabot: a configuration is provided by the template, see the configuration documentation for more details.
- GH actions: enable and manage secrets (it may require to manage them at GitHub organization level)
- Other settings: apply guidelines described in the .github repository

Use the node version declared in .nvmrc. You can use a Node version manager like nvm: nvm use

Install dependencies: npm install

Start the dev server: npm run dev

The demo is accessible at http://localhost:5173/

The code should be linted with xo. To have support in your favorite IDE, see the how-to used in IDE documentation.

To lint the code, run npm run lint.

The code of this demo is released under the Apache 2.0 license.

When all updates have been completed, you are ready to publish a new release.

Notes: use the previous releases as a source of inspiration.

Create a new GitHub release by following the GitHub help

for Tag version, use a value following the vX.Y.Z scheme using the Semantic Versioning.
for Target
- usually, keep the main branch except if new commits that you don't want to integrate for the release are already available in the branch
- in that case, choose a dedicated commit
Description
- briefly explain the contents of the new version
- if the bpmn-visualization version is updated, mention it
- make GitHub generates the release notes automatically
Generate and attach an archive of the demo
- generate the demo archive by running npm run build with the code of the commit that will be used for the release
- zip the demo archive into bpmn-visualization-demo-template-X.Y.Z.zip
- generate the checksum of the archive and store it in a bpmn-visualization-demo-template-X.Y.Z_checksums.txt file by running: sha256sum ./bpmn-visualization-demo-template-X.Y.Z.zip
- attach the demo and the checksum files as an asset of the release
- in the release notes, explain how to run the demo attached to this release

GitHub Pages (demo live environment)

surge.sh (demo preview environment)