Skip to content

Commit ccc2be8

Browse files
Doco/updates (#2)
* Expose simulator port 1880 * Remove unused grunt config * Fix subtitle & project paths * Bump revision
1 parent 50cb3ff commit ccc2be8

File tree

6 files changed

+38
-37
lines changed

6 files changed

+38
-37
lines changed

Gruntfile.js

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
module.exports = function (grunt) {
22
require('load-grunt-tasks')(grunt)
33

4-
grunt.loadNpmTasks('grunt-execute')
54
grunt.loadNpmTasks('grunt-contrib-clean')
65
grunt.loadNpmTasks('grunt-multi-dest')
76
grunt.loadNpmTasks('grunt-babel')
@@ -35,18 +34,6 @@ module.exports = function (grunt) {
3534
process: content => content.replace(/(\'|")ion.rangeSlider(\'|")/g, '$1./ion.rangeSlider.min$2'), // eslint-disable-line
3635
}
3736
},
38-
echarts_libs: {
39-
cwd: 'node_modules/echarts/dist',
40-
expand: true,
41-
src: ['echarts.min.js'],
42-
dest: 'dist/libs/'
43-
},
44-
image_to_dist: {
45-
cwd: 'src',
46-
expand: true,
47-
src: ['src/image/**/*'],
48-
dest: 'dist/image/'
49-
},
5037
pluginDef: {
5138
expand: true,
5239
src: ['plugin.json'],
@@ -115,7 +102,6 @@ module.exports = function (grunt) {
115102
'copy:readme',
116103
'string-replace',
117104
'copy:pluginDef',
118-
'copy:image_to_dist',
119105
'babel'])
120106

121107
grunt.registerTask('build', [

README.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Libre Order Mgt Table Panel for scheduler
22

3-
| A Libre panel to create, schedule and release orders for manufacture
3+
> A Libre panel to create, schedule and release orders for manufacture
44
55
This panel gives a scheduler the ability to create, update and delete manufacturing orders for a production line and product. In addition to creating orders, this panel allows schedulers to release an order for manufacture. Business rules are in place to prevent changes to an order that has already been executed on. This panel is part of [Libre](https://github.com/Spruik/Libre). This plugin interfaces to a no security json rest api for equipment, orders and products running on the same grafana server. This panel is targeted at Grafana v6.x.x. only.
66

@@ -110,7 +110,7 @@ Start by cloning this repository
110110
```shell
111111
~/
112112
$ git clone https://github.com/Spruik/Libre-Scheduler-Order-Mgt-Table-Panel
113-
Cloning into 'libre-scheduler-order-mgt-table-panel'...
113+
Cloning into 'Libre-Scheduler-Order-Mgt-Table-Panel'...
114114
remote: Enumerating objects: 46, done.
115115
remote: Counting objects: 100% (46/46), done.
116116
remote: Compressing objects: 100% (31/31), done.
@@ -121,8 +121,8 @@ Unpacking objects: 100% (46/46), done.
121121
Enter project and install dependencies
122122

123123
```shell
124-
$ cd ./libre-scheduler-order-mgt-table-panel
125-
~/libre-scheduler-order-mgt-table-panel
124+
$ cd ./Libre-Scheduler-Order-Mgt-Table-Panel
125+
~/Libre-Scheduler-Order-Mgt-Table-Panel
126126
$ npm install
127127
...
128128
added 714 packages from 399 contributors and audited 719 packages in 11.871s
@@ -143,17 +143,22 @@ Run grunt to build the panel
143143

144144
```shell
145145
$ grunt
146-
147146
Running "copy:src_to_dist" (copy) task
148-
Created 2 directories, copied 8 files
147+
Created 3 directories, copied 10 files
149148

150149
Running "copy:libs" (copy) task
150+
Copied 2 files
151+
152+
Running "copy:readme" (copy) task
153+
Created 1 directory, copied 8 files
154+
155+
Running "string-replace:dist" (string-replace) task
156+
157+
1 files created
151158

152159
Running "copy:pluginDef" (copy) task
153160
Copied 1 file
154161

155-
Running "copy:image_to_dist" (copy) task
156-
157162
Running "babel:dist" (babel) task
158163

159164
Done, without errors.
@@ -163,18 +168,20 @@ Done, without errors.
163168
Start docker-compose.dev.yml detached
164169

165170
```shell
166-
~/libre-scheduler-order-mgt-table-panel
167-
$ docker-compose -f docker-compose.dev.yml up -d
168-
Starting libre-scheduler-order-mgt-table-panel_postgres_1
169-
Starting libre-scheduler-order-mgt-table-panel_postrest_1
170-
Starting libre-scheduler-order-mgt-table-panel_simulator_1
171-
Starting libre-scheduler-order-mgt-table-panel_grafana_1
171+
~/Libre-Scheduler-Order-Mgt-Table-Panel
172+
$ docker-compose -f docker-compose.dev.yaml up -d
173+
Starting libre-scheduler-order-mgt-table-panel_influx_1 ... done
174+
Starting libre-scheduler-order-mgt-table-panel_postgres_1 ... done
175+
Starting libre-scheduler-order-mgt-table-panel_postrest_1 ... done
176+
Recreating libre-scheduler-order-mgt-table-panel_simulator_1 ... done
177+
Starting libre-scheduler-order-mgt-table-panel_grafana_1 ... done
178+
172179
```
173180

174181
Run grunt watch to recompile on change
175182

176183
```shell
177-
~/libre-scheduler-order-mgt-table-panel
184+
~/Libre-Scheduler-Order-Mgt-Table-Panel
178185
$ grunt watch
179186
Running "watch" task
180187
Waiting...
@@ -192,7 +199,7 @@ Prerequisites
192199
Build panel and zip into archive
193200

194201
```shell
195-
~/libre-scheduler-order-mgt-table-panel
202+
~/Libre-Scheduler-Order-Mgt-Table-Panel
196203
$ grunt build
197204
Running "clean:0" (clean) task
198205
>> 1 path cleaned.
@@ -201,10 +208,10 @@ Running "clean:1" (clean) task
201208
>> 1 path cleaned.
202209

203210
Running "copy:src_to_dist" (copy) task
204-
Created 3 directories, copied 9 files
211+
Created 3 directories, copied 10 files
205212

206213
Running "copy:libs" (copy) task
207-
214+
Copied 2 files
208215

209216
Running "copy:readme" (copy) task
210217
Created 1 directory, copied 8 files
@@ -219,9 +226,10 @@ Copied 1 file
219226
Running "babel:dist" (babel) task
220227

221228
Running "compress:main" (compress) task
222-
>> Compressed 44 files.
229+
>> Compressed 52 files.
223230

224231
Done, without errors.
232+
225233
```
226234

227235
Find a completed build of this panel in the root directory named `libre-scheduler-order-mgt-table-panel.zip`.
@@ -236,4 +244,9 @@ For any issue, there are fundamentally three ways an individual can contribute:
236244

237245
## Change log
238246

247+
- 1.0.1 Documentation Updates
248+
- Expose simulator port 1880
249+
- Remove unused grunt config
250+
- Fix subtitle & project paths
251+
239252
- 1.0.0 Initial Public Release

docker-compose.dev.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ services:
3939
- 8086:8086
4040
simulator:
4141
image: spruiktec/libre-simulator
42+
ports:
43+
- 1880:1880
4244
depends_on:
4345
- postrest
4446
postgres:

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "libre-scheduler-order-mgt-table-panel",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "A Libre panel to create, schedule and release orders for manufacture",
55
"repository": {
66
"type": "git",

plugin.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
"small": "img/icn-table-panel.svg",
2525
"large": "img/icn-table-panel.svg"
2626
},
27-
"version": "1.0.0",
28-
"updated": "2020-07-01"
27+
"version": "1.0.1",
28+
"updated": "2020-07-16"
2929
},
3030
"dependencies": {
3131
"grafanaVersion": "6.x.x",

0 commit comments

Comments
 (0)