Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(demo): better explain how to use the PathResolver demo #61

Merged
merged 1 commit into from
Aug 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,7 @@ This project uses [npm workspaces](https://docs.npmjs.com/cli/v9/using-npm/works

Install dependencies: `npm install`

Running the demo only:
- Build the lib: `npm run build -w packages/addons`
- Run the demo: `npm run dev -w packages/demo`. The demo is accessible at http://localhost:5173/

Develop the lib and live update the demo
- run `npm run dev`
Develop the lib and live update the demo: run `npm start`. The demo is accessible at http://localhost:5173/


## 📃 License
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"./packages/*"
],
"scripts": {
"dev": "concurrently -n lib,demo \"npm run dev -w packages/addons\" \"npm run dev -w packages/demo\""
"start": "concurrently -n lib,demo \"npm run dev -w packages/addons\" \"npm run dev -w packages/demo\""
},
"devDependencies": {
"concurrently": "~8.2.0",
Expand Down
10 changes: 4 additions & 6 deletions packages/demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@ <h1>bv-experimental-add-ons</h1>
<code>bv-experimental-add-ons</code> provides new experimental features for <a href="https://github.com/process-analytics/bpmn-visualization-js" target="_blank">bpmn-visualization</a>.
<p>

<div>
<div class="source-code">
<span>Source code:</span>
<a href="https://github.com/process-analytics/bv-experimental-add-ons" target="_blank" class="gh-logo" title="Go to the bv-experimental-add-ons GitHub repository"><img src="/assets/github-logo.svg" id="gh-logo" alt="The GitHub logo"></a>
</div>
<code>bpmn-visualization</code> examples: <a href="https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html" target="_blank"><i>⏩ live environment</i></a>
<div class="source-code">
<span>Source code:</span>
<a href="https://github.com/process-analytics/bv-experimental-add-ons" target="_blank" class="gh-logo" title="Go to the bv-experimental-add-ons GitHub repository"><img src="/assets/github-logo.svg" id="gh-logo" alt="The GitHub logo"></a>
</div>

</section>
Expand All @@ -32,6 +29,7 @@ <h1>Available demos</h1>
<ul>
<li><a href="./pages/path-resolver.html">PathResolver</a>: Infer path after selecting some flow nodes.</li>
</ul>
As a reminder, <code>bpmn-visualization</code> examples and demos: <a href="https://cdn.statically.io/gh/process-analytics/bpmn-visualization-examples/master/examples/index.html" target="_blank"><i>⏩ live environment</i></a>
</section>
</body>
</html>
5 changes: 4 additions & 1 deletion packages/demo/pages/path-resolver.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
<h1>PathResolver demo</h1>
</header>
<section class="presentation">
<div class="description">Select or deselect BPMN flow nodes, then compute the missing flows in the path.</div>
<div class="description">
Select or deselect BPMN flow nodes, then compute the missing flows in the path.
<br>
<b>TIP</b>: you can then update the selection and recompute the path.</div>
<div class="controls">
<button id="btn-compute-path">Compute path</button>
<button id="bt-clear">Clear</button>
Expand Down
7 changes: 4 additions & 3 deletions packages/demo/src/path-resolver.css
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,14 @@ header {
}

#bpmn-container {
height: 80vh;
width: 98vw;
overflow: hidden;
border-style: solid;
border-color: #b0b0b0;
border-width: .1rem;
border-radius: .2rem;

margin: auto;
width: 96vw;
margin-top: 1.25rem;
margin-bottom: 1.5rem;
flex-grow: 1;
}
1 change: 0 additions & 1 deletion packages/demo/src/path-resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import {BpmnElement, BpmnVisualization, FitType} from 'bpmn-visualization';
import {PathResolver, ShapeUtil} from "@process-analytics/bv-experimental-add-ons";
// This is simple example of the BPMN diagram, loaded as string. The '?.raw' extension support is provided by Vite.
// For other load methods, see https://github.com/process-analytics/bpmn-visualization-examples
// eslint-disable-next-line n/file-extension-in-import -- Vite syntax
import diagram from './diagram.bpmn?raw';

// Instantiate BpmnVisualization, pass the container HTMLElement - present in path-resolver.html
Expand Down