lmu/uni2work.workflows.visualiser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
David Mosbach 2023-08-26 05:23:35 +02:00
parent 398f5f18ed
commit e42aa4cc76
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,16 +1,23 @@
# Workflow Visualiser
## Usage
You need to host a local http server for providing the definition files. Please create a dedicated directory @ `localhost` for that purpose.
### Prerequisites
#### Data
First, you need to generate the visualisation data:
```
cabal run workflow-visualiser -- --all <path-to-source-yaml-directory> <directory-of-http-server>
```sh
$ cabal run workflow-visualiser -- --all <path-to-source-yaml-directory> <directory-of-http-server>
```
Afterwards you can run your server and listen on port `8080`.
### Open Editor
Open `editor.html` in your browser and select the desired workflow via the file menu.
#### Frontend
You need to install some libraries:
```sh
$ npm install
```
### Run
Run the following command. This will generate a Webpack bundle from the Typescript source, launch a local http server and open the application in your browser:
```sh
$ npm start
```