@5minds/node-red-contrib-processcube 0.0.5 → 0.0.7
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.
package/README.md
CHANGED
@@ -1,11 +1,60 @@
|
|
1
|
-
|
1
|
+
# ProcessCube Node-RED Integration
|
2
2
|
|
3
|
-
|
3
|
+
This repository contains Node-RED flows for integrating the ProcessCube system. The flows include nodes for starting processes and handling external tasks.
|
4
4
|
|
5
|
-
##
|
5
|
+
## Prerequisites
|
6
6
|
|
7
|
-
|
7
|
+
Before running the Node-RED flows, make sure you have the following prerequisites installed:
|
8
8
|
|
9
|
-
|
9
|
+
- Docker
|
10
|
+
- Docker Compose
|
10
11
|
|
11
|
-
|
12
|
+
## Installation
|
13
|
+
|
14
|
+
To install and run the Node-RED flows, follow these steps:
|
15
|
+
|
16
|
+
1. Clone this repository to your local machine:
|
17
|
+
|
18
|
+
```bash
|
19
|
+
git clone https://github.com/5minds/processcube_nodered.git
|
20
|
+
```
|
21
|
+
|
22
|
+
2. Change to the project directory:
|
23
|
+
|
24
|
+
```bash
|
25
|
+
cd processcube_nodered
|
26
|
+
```
|
27
|
+
|
28
|
+
3. Build the Docker containers:
|
29
|
+
|
30
|
+
```bash
|
31
|
+
docker-compose build
|
32
|
+
```
|
33
|
+
|
34
|
+
4. Start the Docker containers:
|
35
|
+
|
36
|
+
```bash
|
37
|
+
docker-compose up -d
|
38
|
+
```
|
39
|
+
|
40
|
+
## Usage
|
41
|
+
|
42
|
+
Once the Docker containers are running, you can access the ProcessCube Node-RED interface using the following URLs:
|
43
|
+
|
44
|
+
- Engine: [http://localhost:8000](http://localhost:8000)
|
45
|
+
- Node-RED: [http://localhost:1880](http://localhost:1880)
|
46
|
+
|
47
|
+
In the Node-RED interface, you will find pre-configured flows for starting processes and handling external tasks. You can customize these flows to fit your specific requirements.
|
48
|
+
|
49
|
+
## Contributing
|
50
|
+
|
51
|
+
If you would like to contribute to this project, please follow these guidelines:
|
52
|
+
|
53
|
+
1. Fork the repository on GitHub.
|
54
|
+
2. Create a new branch for your feature or bug fix.
|
55
|
+
3. Commit your changes and push the branch to your fork.
|
56
|
+
4. Submit a pull request to the main repository.
|
57
|
+
|
58
|
+
## License
|
59
|
+
|
60
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
|