camunda-modeler-wakatime-plugin/README.md

Wakatime Plugin for the Camunda Modeler

# camunda-modeler-wakatime-plugin
[Wakatime](https://wakatime.com) Plugin for the [Camunda Modeler](https://github.com/camunda/camunda-modeler)

[![Build Status](https://travis-ci.org/pinussilvestrus/camunda-modeler-wakatime-plugin.svg?branch=master)](https://travis-ci.org/pinussilvestrus/camunda-modeler-wakatime-plugin) [![Compatible with Camunda Modeler version 3.0](https://img.shields.io/badge/Camunda%20Modeler-3.0+-blue.svg)](https://github.com/camunda/camunda-modeler)

## How to use

1. Download and copy this repository into the `plugins` directory of the Camunda Modeler
2. Start the Camunda Modeler
3. When an API-Key is added, the application will start sending activity heartbeats to Wakatime

Due to a current issue (cf. [#53](https://github.com/pinussilvestrus/camunda-modeler-wakatime-plugin/issues/53)) you will have to give the `--dangerously-enable-node-integration` argument when starting the Camunda Modeler application (step 2) to ensure modeling operations are sending correctly to Wakatime.


## Compatibility Notice

Due to the flag loading, this plug-in is compatible with Camunda Modeler `v3.0+`.

## Building

Install dependencies:

```sh
npm install
```

Package plugin to `client/client-bundle.js` + `menu/menu-bundle.js`:

```sh
npm run bundle
```


## Adding Wakatime API-Key

Before the application will send heartbeats to Wakatime, you will have to add an [API-Key](https://wakatime.com/faq#api-key) inside your local `flags.json`

```json
{
    "wakatime-api-key": "YOUR_API_KEY"
}
```

or to `$WAKATIME_HOME/.wakatime.cfg` (likely inside your `$HOME` directory)

```ini

[settings]
api_key = YOUR_API_KEY

```

## Screenshots

![](./resources/wakatime-screenshot.png)

## Logging

To enable logging different actions + errors to the Camunda  Modeler application log, simply add the `debug` option to your `$WAKATIME_HOME/.wakatime.cfg` configuration

```ini

[settings]
debug = true

```


## Additional Resources

* [Camunda Modeler: Flags documentation](https://github.com/camunda/camunda-modeler/tree/master/docs/flags)
* [Camunda Modeler: Plugins documentation](https://github.com/camunda/camunda-modeler/tree/master/docs/plugins)
* [Wakatime: Configuration documentation](https://github.com/wakatime/wakatime#configuring)


## Licence

MIT