https://github.com/process-analytics/bpmn-visualization-demo-template
A template to quickly initiate a `bpmn-visualization` demo powered by `Vite` and written in `TypeScript`
https://github.com/process-analytics/bpmn-visualization-demo-template
bpmn demo low-quality template typescript visualization vitejs
Last synced: about 2 months ago
JSON representation
A template to quickly initiate a `bpmn-visualization` demo powered by `Vite` and written in `TypeScript`
- Host: GitHub
- URL: https://github.com/process-analytics/bpmn-visualization-demo-template
- Owner: process-analytics
- License: apache-2.0
- Created: 2023-03-09T10:09:13.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-13T16:19:03.000Z (4 months ago)
- Last Synced: 2025-01-13T17:27:27.433Z (4 months ago)
- Topics: bpmn, demo, low-quality, template, typescript, visualization, vitejs
- Language: TypeScript
- Homepage: https://process-analytics.github.io/bpmn-visualization-demo-template/
- Size: 777 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bpmn-visualization-demo-template
| Archived on 2024-01-13 | We no longer use this repository. |
| -------- | -------- |
A template repository to quickly initiate a [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) demo
- powered by [Vite](https://vitejs.dev/)
- written in [TypeScript](https://www.typescriptlang.org/)
## 🤔 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](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow)
- Dependabot: a configuration is provided by the template, see the [configuration documentation](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates) 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](https://github.com/process-analytics/.github/) repository
## 🎮 Live demo
The live demo is available at ⏩ https://process-analytics.github.io/bpmn-visualization-demo-template/
## ⚒️ Development Setup
Use the node version declared in [.nvmrc](.nvmrc). You can use a Node version manager like [nvm](https://github.com/nvm-sh/nvm): `nvm use`
Install dependencies: `npm install`
Start the dev server: `npm run dev`
The demo is accessible at http://localhost:5173/
### 🎨 Code linter
The code should be linted with [xo](https://github.com/xojs/xo). To have support in your favorite IDE, see the [how-to used in IDE](https://github.com/xojs/xo#editor-plugins) documentation.
To lint the code, run `npm run lint`.
## 📃 License
The code of this demo is released under the [Apache 2.0](LICENSE) license.
## 🚀 Release how-to
When all updates have been completed, you are ready to publish a new release.
Notes: use the previous [releases](https://github.com/process-analytics/bpmn-visualization-demo-template/releases) as a source of inspiration.
Create a new GitHub release by following the [GitHub help](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)
- for `Tag version`, use a value following the **vX.Y.Z** scheme using the [Semantic Versioning](https://semver.org/).
- 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](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
- 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
## ⚡ Powered by
**[GitHub Pages](https://pages.github.com/)** (demo live environment)
**[surge.sh](https://surge.sh)** (demo preview environment)