@@ -83,10 +83,6 @@ The web app provides:
83
83
84
84
Demo Application(Express or NestJS) , provides a complete implementation of users management using Passport and MongoDB
85
85
86
- # Application Integration
87
-
88
- ` bpmn-server ` is intended to be integrated into your application[ see] ( ./docs/customization.md )
89
-
90
86
# Full Demo Web Application
91
87
92
88
We Provide a full demo @ https://bpmn.omniworkflow.com
@@ -96,38 +92,36 @@ We Provide a full demo @ https://bpmn.omniworkflow.com
96
92
This package requires Node.js and an access to MongoDB ()
97
93
if you don't have MongoDB already installed you can [ create a free cloud account here] ( http://bit.ly/cyd-atlas )
98
94
95
+ ### 1. git clone
99
96
``` sh
100
97
101
98
> git clone https://github.com/bpmnServer/bpmn-web.git
102
-
99
+ ```
100
+ ### 2. install packages
101
+ ```
103
102
> npm install
104
-
103
+ ``````
104
+ ### 3. setup the app
105
+ ```
105
106
> npm run setup
106
107
```
108
+
107
109
Edit .env file to have MongoDB point to your server or free cloud account
108
110
109
111
```env
110
- # PORT # for express application
111
- PORT=3000
112
-
113
- #API_KEY is used for remote access
114
- API_KEY=12345
115
-
116
112
# MongoDB Settings
117
113
MONGO_DB_URL=mongodb://0.0.0.0:27017/bpmn
118
114
#
119
- ... more settings
120
115
```
121
-
122
- - Run Setup one more time
116
+ - Run Setup again to create db objects
123
117
124
118
``` sh
125
119
> npm run setup
126
120
```
127
121
128
122
Your installation is now complete.
129
123
130
- ## To start server
124
+ ### 4. Start server
131
125
132
126
``` sh
133
127
> npm run start
@@ -146,9 +140,59 @@ App is running at http://localhost:3000 in development mode
146
140
147
141
Use your browser to view the bpmn-server running
148
142
149
- ## Command Line Interface
143
+ ## Docker installation
144
+ <details >
145
+ <summary >
146
+ To install MongoDB, bpmn-server and bpmn-web in on a docker container
147
+ </summary >
150
148
149
+ #### 1. Create a folder , cd to folder
150
+ #### 2. Create a ` docker-compose.yml ` as follows:
151
+ ```
152
+ version: "3.7"
153
+ name: bpmn-server
154
+ services:
155
+ bpmn-web:
156
+ image: ralphhanna/bpmn-web
157
+ command: sh -c "
158
+ npm run setup &&
159
+ npm run start"
160
+ ports:
161
+ - 3000:3000
162
+ volumes:
163
+ - 'app:/app'
164
+ depends_on:
165
+ - mongo
166
+ mongo:
167
+ image: mongo
168
+ ports:
169
+ - 27017:27017
170
+ volumes:
171
+ - mongodb:/data/db
172
+ volumes:
173
+ mongodb:
174
+ driver: local
175
+ driver_opts:
176
+ type: 'none'
177
+ o: 'bind'
178
+ device: './mongodb_volume'
179
+ app:
180
+ driver: local
181
+ driver_opts:
182
+ type: 'none'
183
+ o: 'bind'
184
+ device: './bpmn_server_volume'
185
+
186
+ ```
187
+ #### 3. start the container ` docker compose up -d `
188
+
189
+ </details >
190
+
191
+ ## Command Line Interface
192
+ <details >
193
+ <summary >
151
194
bpmnServer provide some basic functionalities using CLI
195
+ </summary >
152
196
153
197
``` sh
154
198
> npm run cli
@@ -177,11 +221,16 @@ Enter Command, q to quit, or ? to list commands
177
221
>
178
222
```
179
223
224
+ </details >
225
+
180
226
## to update to latest release
181
227
182
228
``` sh
183
229
> npm update bpmn-server
184
230
```
231
+ # Application Integration
232
+
233
+ ` bpmn-server ` is intended to be integrated into your application [ see] ( ./docs/customization.md )
185
234
186
235
# Documentation
187
236
0 commit comments