Skip to content

Commit f648165

Browse files
committed
improve docs
1 parent 0992ba4 commit f648165

File tree

4 files changed

+113
-20
lines changed

4 files changed

+113
-20
lines changed

README.md

+66-17
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,6 @@ The web app provides:
8383

8484
Demo Application(Express or NestJS) , provides a complete implementation of users management using Passport and MongoDB
8585

86-
# Application Integration
87-
88-
`bpmn-server` is intended to be integrated into your application[see](./docs/customization.md)
89-
9086
# Full Demo Web Application
9187

9288
We Provide a full demo @ https://bpmn.omniworkflow.com
@@ -96,38 +92,36 @@ We Provide a full demo @ https://bpmn.omniworkflow.com
9692
This package requires Node.js and an access to MongoDB ()
9793
if you don't have MongoDB already installed you can [create a free cloud account here](http://bit.ly/cyd-atlas)
9894

95+
### 1. git clone
9996
```sh
10097

10198
> git clone https://github.com/bpmnServer/bpmn-web.git
102-
99+
```
100+
### 2. install packages
101+
```
103102
> npm install
104-
103+
``````
104+
### 3. setup the app
105+
```
105106
> npm run setup
106107
```
108+
107109
Edit .env file to have MongoDB point to your server or free cloud account
108110
109111
```env
110-
# PORT # for express application
111-
PORT=3000
112-
113-
#API_KEY is used for remote access
114-
API_KEY=12345
115-
116112
# MongoDB Settings
117113
MONGO_DB_URL=mongodb://0.0.0.0:27017/bpmn
118114
#
119-
... more settings
120115
```
121-
122-
- Run Setup one more time
116+
- Run Setup again to create db objects
123117

124118
```sh
125119
> npm run setup
126120
```
127121

128122
Your installation is now complete.
129123

130-
## To start server
124+
### 4. Start server
131125

132126
```sh
133127
> npm run start
@@ -146,9 +140,59 @@ App is running at http://localhost:3000 in development mode
146140

147141
Use your browser to view the bpmn-server running
148142

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>
150148

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>
151194
bpmnServer provide some basic functionalities using CLI
195+
</summary>
152196

153197
```sh
154198
>npm run cli
@@ -177,11 +221,16 @@ Enter Command, q to quit, or ? to list commands
177221
>
178222
```
179223

224+
</details>
225+
180226
## to update to latest release
181227

182228
```sh
183229
> npm update bpmn-server
184230
```
231+
# Application Integration
232+
233+
`bpmn-server` is intended to be integrated into your application [see](./docs/customization.md)
185234

186235
# Documentation
187236

docs/README.md

+44
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,50 @@ App is running at http://localhost:3000 in development mode
146146

147147
Use your browser to view the bpmn-server running
148148

149+
### Docker installation
150+
To install MongoDB, bpmn-server and bpmn-web in on container
151+
#### 1. Create a folder
152+
#### 2. create a `docker-compose.yml` as follows:
153+
```
154+
version: "3.7"
155+
name: bpmn-server
156+
services:
157+
bpmn-web:
158+
image: ralphhanna/bpmn-web
159+
command: sh -c "
160+
npm run setup &&
161+
npm run start"
162+
ports:
163+
- 3000:3000
164+
volumes:
165+
- 'app:/app'
166+
depends_on:
167+
- mongo
168+
mongo:
169+
image: mongo
170+
ports:
171+
- 27017:27017
172+
volumes:
173+
- mongodb:/data/db
174+
volumes:
175+
mongodb:
176+
driver: local
177+
driver_opts:
178+
type: 'none'
179+
o: 'bind'
180+
device: './mongodb_volume'
181+
app:
182+
driver: local
183+
driver_opts:
184+
type: 'none'
185+
o: 'bind'
186+
device: './bpmn_server_volume'
187+
188+
```
189+
#### 3. start the container `docker compose up -d`
190+
191+
192+
149193
## Command Line Interface
150194

151195
bpmnServer provide some basic functionalities using CLI

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bpmn-server",
3-
"version": "2.0.9-alpha3",
3+
"version": "2.0.10-alpha4",
44
"description": "BPMN 2.0 Server including Modeling, Execution and Presistence, an open source for Node.js",
55
"license": "MIT",
66
"scripts": {

0 commit comments

Comments
 (0)