Skip to content

Commit

Permalink
docs: align hacking section with other libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
nikku authored and marstamm committed Dec 14, 2023
1 parent 1378759 commit 48cc724
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,29 +31,31 @@ Some libraries / applications built on top of diagram-js:
* [Examples](https://github.com/bpmn-io/diagram-js-examples)


## Hacking the Project
## Development

To get the development setup make sure to have [NodeJS](https://nodejs.org/en/download/) installed.
As soon as you are set up, clone the project and execute
Prepare the project by installing all dependencies:

```
```sh
npm install
```

Then, depending on your use-case you may run any of the following commands:

### Testing

Execute `npm run dev` to run the test suite in watch mode.

Expose an environment variable `TEST_BROWSERS=(Chrome|Firefox|IE)` to execute the tests in a non-headless browser.
```sh
# build the library and run all tests
npm run all

# run the development setup
npm run dev

### Package

Execute `npm run all` to lint and test the project.
# run tests (single run)
npm test
```

__Note:__ We do not generate any build artifacts. Required parts of the library should be bundled by modelers / viewers as needed instead.
Expose an environment variable `TEST_BROWSERS=(Chrome|Firefox)` to execute the tests in a non-headless browser.

> [!NOTE]
> We do not generate any build artifacts. Required parts of the library should be bundled by consuming libraries as needed instead.

## License
Expand Down

0 comments on commit 48cc724

Please sign in to comment.