https://github.com/bpmn-io/bpmn-js-nyan

bpmn-js, nyan cat style :rainbow: :cat:
https://github.com/bpmn-io/bpmn-js-nyan

bpmn-js

Last synced: 3 months ago
JSON representation

bpmn-js, nyan cat style :rainbow: :cat:

• Host: GitHub
• URL: https://github.com/bpmn-io/bpmn-js-nyan
• Owner: bpmn-io
• License: mit
• Created: 2015-09-16T17:28:16.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-07-26T14:24:06.000Z (3 months ago)
• Last Synced: 2024-07-27T01:12:42.062Z (3 months ago)
• Topics: bpmn-js
• Language: JavaScript
• Homepage:
• Size: 2.78 MB
• Stars: 89
• Watchers: 11
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bpmn-io - bpmn-js-nyan - An extension that adds custom resize rules, theming and colors (Extensions)

README

        
> If you're interested in custom elements in general, head over to our [:notebook: custom-elements guide](https://github.com/bpmn-io/bpmn-js-examples/tree/master/custom-elements) to get an overview first.

# bpmn-js-nyan

[![CI](https://github.com/bpmn-io/bpmn-js-nyan/workflows/CI/badge.svg)](https://github.com/bpmn-io/bpmn-js-nyan/actions?query=workflow%3ACI)

[bpmn-js](https://github.com/bpmn-io/bpmn-js) + !["nyan cat in the wild"](./docs/cat.gif) = auto-win.

This projects bundles lovely nyan cats into a custom BPMN 2.0 modeler.

## About

Stand out and integrate nyan cats into your next BPMN Modeler!

!["nyan cat in bpmn-js"](./docs/screencast.gif)

## Great Features

* [Custom Colors](./lib/color-picker)

* [Nyan Cats](./lib/nyan)

* [Resize all elements](./lib/resize-all-rules)

## Usage

```javascript

import BpmnModeler from 'bpmn-js/lib/Modeler';

import resizeAllModule from 'bpmn-js-nyan/lib/resize-all-rules';

import colorPickerModule from 'bpmn-js-nyan/lib/color-picker';

import nyanDrawModule from 'bpmn-js-nyan/lib/nyan/draw';

import nyanPaletteModule from 'bpmn-js-nyan/lib/nyan/palette';

var bpmnJS = new BpmnModeler({

  additionalModules: [

    resizeAllModule,

    colorPickerModule,

    nyanDrawModule,

    nyanPaletteModule

  ]

});

```

## Building

To build, lint and test the project run

```

npm install

npm run all

```

To spin up the test interactively in the browser, execute

```

npm run dev

```

Visit [localhost:9876/debug.html](http://localhost:9876/debug.html) in your browser.

## Related

If you enjoy nyan cats you might be interested in these related examples, too:

* [Colors](https://github.com/bpmn-io/bpmn-js-examples/tree/master/colors)

* [Custom Elements](https://github.com/bpmn-io/bpmn-js-examples/tree/master/custom-elements)

* [Custom Modeling Rules](https://github.com/bpmn-io/bpmn-js-examples/tree/master/custom-modeling-rules)

* [Theming](https://github.com/bpmn-io/bpmn-js-examples/tree/master/theming)

## License

MIT