@camunda/task-testing 1.0.5 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +46 -34
  3. package/dist/index.js +1 -1
  4. package/dist/index.js.map +1 -1
  5. package/package.json +95 -94
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2022-present Camunda Services GmbH
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ MIT License
2
+
3
+ Copyright (c) 2022-present Camunda Services GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
package/README.md CHANGED
@@ -1,35 +1,47 @@
1
- # @camunda/task-testing
2
-
3
- [![CI](https://github.com/camunda/task-testing/actions/workflows/CI.yml/badge.svg)](https://github.com/camunda/task-testing/actions/workflows/CI.yml)
4
-
5
- Run and test a single building block of your BPMN diagram.
6
-
7
- ## Try it
8
-
9
- [Demo](https://scaling-chainsaw-lro45v3.pages.github.io/)
10
-
11
- ## Usage
12
-
13
- ## Development
14
-
15
- Install the dependencies and spin up a local server at [http://localhost:3000](http://localhost:3000):
16
-
17
- ```
18
- npm install
19
-
20
- npm start
21
- ```
22
-
23
- If you want to run it against a real Camunda 8 cluster, provide `demo/.env` file with client credentials.
24
-
25
- ## Build
26
-
27
- Run all tests and build the library:
28
-
29
- ```
30
- npm run all
31
- ```
32
-
33
- ## License
34
-
1
+ # @camunda/task-testing
2
+
3
+ [![CI](https://github.com/camunda/task-testing/actions/workflows/CI.yml/badge.svg)](https://github.com/camunda/task-testing/actions/workflows/CI.yml)
4
+
5
+ Run and test a single building block of your BPMN diagram.
6
+
7
+ ## Try it
8
+
9
+ [Demo](https://scaling-chainsaw-lro45v3.pages.github.io/)
10
+
11
+ ## Usage
12
+
13
+ The library exposes a single React component:
14
+
15
+ ```js
16
+ import TaskTesting from '@camunda/task-testing';
17
+ ```
18
+
19
+ The configuration is passed via the [props of the TaskTesting component](https://github.com/camunda/task-testing/blob/fa1d39874f532e669adec7d7a76aaf0fd99e0e5a/lib/components/TaskTesting/TaskTesting.js#L50).
20
+
21
+ ## Development
22
+
23
+ Install the dependencies and spin up a local server at [http://localhost:3000](http://localhost:3000):
24
+
25
+ ```
26
+ npm install
27
+
28
+ npm start
29
+ ```
30
+
31
+ It requires a Camunda 8 instance to run.
32
+
33
+ We recommend using [Camunda 8 Run](https://docs.camunda.io/docs/self-managed/quickstart/developer-quickstart/c8run/) for development.
34
+
35
+ You can configure your Camunda 8 environment in the `demo/.env` file.
36
+
37
+ ## Build
38
+
39
+ Run all tests and build the library:
40
+
41
+ ```
42
+ npm run all
43
+ ```
44
+
45
+ ## License
46
+
35
47
  MIT