Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.8 KB

README.md

File metadata and controls

47 lines (27 loc) · 1.8 KB
Raw

Inscription View

This repo contains the web-based next gen inscription view for Axon Ivy process elements.

Client

It is build with React and Headless Components.

Available Scripts

npm i: Install all packages:

npm run build: Compiles typescript

npm run package: Compiles and bundles production ready

It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

npm run test: Launches the test runner in the interactive watch mode

npm run standalone start: Start the editor

Runs the standalone app in the development mode. Open http://localhost:3000 to view it in the browser. If you don't have an active LSP backend, you can test the frontend with a mocked backend. Open http://localhost:3000/mock.html to view mocked data. The page will reload if you make edits.

If you have started a Dev-Axon Ivy Designer (port 8081), you can browse any inscription by addressing it via the app, pmv and pid e.g. http://localhost:3000?server=localhost:8081&app=designer&pmv=workflow-demos&pid=15254DC87A1B183B-f3

VsCode dev environment

Debug

Simply start the Chrome launch config to get debug and breakpoint support.

Run tests

To run tests you can ether start a script above or start Playwright or Vitest with the recommended workspace extensions.

Protocol changes

If you make protocol changes in the server and this causes to type errors on the build, you need to update the protocol in the client.

  • Run npm run protocol generate to update the inscription.ts to the newest schema
  • Run npm run type to check for typeing issues
  • Fix typing issues
  • Create a PR with your changes