Skip to content

Commit

Permalink
Doco/updates (#2)
Browse files Browse the repository at this point in the history
* Expose simulator port 1880

* Remove unused grunt config

* Fix subtitle & project paths

* Bump revision
  • Loading branch information
tomhollingworth authored Jul 16, 2020
1 parent 50cb3ff commit ccc2be8
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 37 deletions.
14 changes: 0 additions & 14 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
module.exports = function (grunt) {
require('load-grunt-tasks')(grunt)

grunt.loadNpmTasks('grunt-execute')
grunt.loadNpmTasks('grunt-contrib-clean')
grunt.loadNpmTasks('grunt-multi-dest')
grunt.loadNpmTasks('grunt-babel')
Expand Down Expand Up @@ -35,18 +34,6 @@ module.exports = function (grunt) {
process: content => content.replace(/(\'|")ion.rangeSlider(\'|")/g, '$1./ion.rangeSlider.min$2'), // eslint-disable-line
}
},
echarts_libs: {
cwd: 'node_modules/echarts/dist',
expand: true,
src: ['echarts.min.js'],
dest: 'dist/libs/'
},
image_to_dist: {
cwd: 'src',
expand: true,
src: ['src/image/**/*'],
dest: 'dist/image/'
},
pluginDef: {
expand: true,
src: ['plugin.json'],
Expand Down Expand Up @@ -115,7 +102,6 @@ module.exports = function (grunt) {
'copy:readme',
'string-replace',
'copy:pluginDef',
'copy:image_to_dist',
'babel'])

grunt.registerTask('build', [
Expand Down
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Libre Order Mgt Table Panel for scheduler

| A Libre panel to create, schedule and release orders for manufacture
> A Libre panel to create, schedule and release orders for manufacture
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.

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

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

```shell
$ grunt

Running "copy:src_to_dist" (copy) task
Created 2 directories, copied 8 files
Created 3 directories, copied 10 files

Running "copy:libs" (copy) task
Copied 2 files

Running "copy:readme" (copy) task
Created 1 directory, copied 8 files

Running "string-replace:dist" (string-replace) task

1 files created

Running "copy:pluginDef" (copy) task
Copied 1 file

Running "copy:image_to_dist" (copy) task

Running "babel:dist" (babel) task

Done, without errors.
Expand All @@ -163,18 +168,20 @@ Done, without errors.
Start docker-compose.dev.yml detached

```shell
~/libre-scheduler-order-mgt-table-panel
$ docker-compose -f docker-compose.dev.yml up -d
Starting libre-scheduler-order-mgt-table-panel_postgres_1
Starting libre-scheduler-order-mgt-table-panel_postrest_1
Starting libre-scheduler-order-mgt-table-panel_simulator_1
Starting libre-scheduler-order-mgt-table-panel_grafana_1
~/Libre-Scheduler-Order-Mgt-Table-Panel
$ docker-compose -f docker-compose.dev.yaml up -d
Starting libre-scheduler-order-mgt-table-panel_influx_1 ... done
Starting libre-scheduler-order-mgt-table-panel_postgres_1 ... done
Starting libre-scheduler-order-mgt-table-panel_postrest_1 ... done
Recreating libre-scheduler-order-mgt-table-panel_simulator_1 ... done
Starting libre-scheduler-order-mgt-table-panel_grafana_1 ... done

```

Run grunt watch to recompile on change

```shell
~/libre-scheduler-order-mgt-table-panel
~/Libre-Scheduler-Order-Mgt-Table-Panel
$ grunt watch
Running "watch" task
Waiting...
Expand All @@ -192,7 +199,7 @@ Prerequisites
Build panel and zip into archive

```shell
~/libre-scheduler-order-mgt-table-panel
~/Libre-Scheduler-Order-Mgt-Table-Panel
$ grunt build
Running "clean:0" (clean) task
>> 1 path cleaned.
Expand All @@ -201,10 +208,10 @@ Running "clean:1" (clean) task
>> 1 path cleaned.

Running "copy:src_to_dist" (copy) task
Created 3 directories, copied 9 files
Created 3 directories, copied 10 files

Running "copy:libs" (copy) task

Copied 2 files

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

Running "compress:main" (compress) task
>> Compressed 44 files.
>> Compressed 52 files.

Done, without errors.

```

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

## Change log

- 1.0.1 Documentation Updates
- Expose simulator port 1880
- Remove unused grunt config
- Fix subtitle & project paths

- 1.0.0 Initial Public Release
2 changes: 2 additions & 0 deletions docker-compose.dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ services:
- 8086:8086
simulator:
image: spruiktec/libre-simulator
ports:
- 1880:1880
depends_on:
- postrest
postgres:
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "libre-scheduler-order-mgt-table-panel",
"version": "1.0.0",
"version": "1.0.1",
"description": "A Libre panel to create, schedule and release orders for manufacture",
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"small": "img/icn-table-panel.svg",
"large": "img/icn-table-panel.svg"
},
"version": "1.0.0",
"updated": "2020-07-01"
"version": "1.0.1",
"updated": "2020-07-16"
},
"dependencies": {
"grafanaVersion": "6.x.x",
Expand Down

0 comments on commit ccc2be8

Please sign in to comment.