Merge pull request #1 from qlik-oss/project-configuration

[QPE-138][QPE-244][QPE-245] Project configuration

.circleci/config.yml

@@ -92,4 +92,3 @@ workflows:
             branches:
               only:
                 - master
-                - project-configuration

LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2018-present QlikTech International AB
+Copyright (c) 2016 Michael Laenen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

LICENSE.md

@@ -1,24 +0,0 @@
-**2 Dimensional Heatmap** Visualization Extension for Qlik Sense is licensed under the "MIT" license:
-
-> 
-> The MIT License (MIT)
-> 
-> Copyright (c) 2016 Michael Laenen
-> 
-> Permission is hereby granted, free of charge, to any person obtaining a copy
-> of this software and associated documentation files (the "Software"), to deal
-> in the Software without restriction, including without limitation the rights
-> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-> copies of the Software, and to permit persons to whom the Software is
-> furnished to do so, subject to the following conditions:
-> 
-> The above copyright notice and this permission notice shall be included in all
-> copies or substantial portions of the Software.
-> 
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-> SOFTWARE.

gulpfile.js

@@ -13,7 +13,7 @@ gulp.task('remove-build-folder', function(){
 
 gulp.task('zip-build', function(){
   return gulp.src(settings.buildDestination + '/**/*')
-    .pipe(zip(settings.name + '_' + settings.version + '.zip'))
+    .pipe(zip(`${settings.name}_${settings.version}.zip`))
     .pipe(gulp.dest(settings.buildDestination));
 });
 
@@ -34,12 +34,12 @@ gulp.task('webpack-build', done => {
 });
 
 gulp.task('update-qext-version', function () {
-  return gulp.src("./build/" + settings.name + ".qext")
+  return gulp.src(`${settings.buildDestination}/${settings.name}.qext`)
     .pipe(jeditor({
       'version': settings.version
     }))
-  .pipe(gulp.dest("./build"));
-})
+    .pipe(gulp.dest(settings.buildDestination));
+});
 
 gulp.task('build',
   gulp.series('remove-build-folder', 'webpack-build', 'update-qext-version', 'zip-build')

readme.md

@@ -1,42 +1,64 @@
 # Qlik Network Chart
 
-[![CircleCI](https://circleci.com/gh/qlik-oss/network-vis-chart.svg?style=svg)](https://circleci.com/gh/qlik-oss/network-vis-chart)
+[![CircleCI](https://circleci.com/gh/qlik-oss/network-vis-chart.svg?style=shield)](https://circleci.com/gh/qlik-oss/network-vis-chart)
 
-<h2>Qlik Sense extension to visualize networks data</h2>
-<hr>
-Based on library vis.js (http://visjs.org)
-<br>Tested with Qlik Sense 2.2.3.
-<hr>
-<h3>Dimensions</h3>
+Qlik Sense extension to visualize networks data based on library vis.js (http://visjs.org).
+Tested with Qlik Sense 2.2.3.
+
+### Dimensions
 4 dimensions are mandatory :
-<ol>
-  <li>node identifier</li>
-  <li>node label</li>
-  <li>node parent identifier</li>
-  <li>node group</li>
-</ol>
 
-<h3>Measures</h3>
+  1. node identifier
+  2. node label
+  3. node parent identifier
+  4. node group
+
+### Measures
 The measures are optional
-<ol>
-  <li>tooltip : expression that will be push in the tooltip when hover on a node</li>
-  <li>node value : used to scale the node size</li>
-  <li>edge value : used to scale the edge width</li>
-</ol>
 
-<h3>Additional network settings</h3>
-<ul>
-<li>Edge Type : select type of curve between nodes</li>
-<li>Node Shape : dot, square, diamond, triangle ...</li>
-<li>Display Edge Value : switch to display the measures on edge curves</li>
-<li>Position Edge Label : top, bottom, middle, horizontal</li>
-<li>Display Shadow : switch to enable shadow effects behind edge and nodes</li>
-</ul>
+  1. tooltip : expression that will be push in the tooltip when hover on a node
+  2. node value : used to scale the node size
+  3. edge value : used to scale the edge width
 
-<h3>Sample</h3>
+### Additional network settings
+* Edge Type : select type of curve between nodes
+* Node Shape : dot, square, diamond, triangle ...
+* Display Edge Value : switch to display the measures on edge curves
+* Position Edge Label : top, bottom, middle, horizontal
+* Display Shadow : switch to enable shadow effects behind edge and nodes
+
+### Sample
 QVF based on characters from Victor Hugo's novel , Les Misérables.
 ![Network chart](resources/network_chart_v1.png)
 
+
+# Getting Started
+
+## Installation
+
+1. Download the extension zip, `qlik-network-chart_<version>.zip`, from the latest release(https://github.com/qlik-oss/network-vis-chart/releases/latest)
+2. Install the extension:
+
+   a. **Qlik Sense Desktop**: unzip to a directory under [My Documents]/Qlik/Sense/Extensions.
+
+   b. **Qlik Sense Server**: import the zip file in the QMC.
+
+
+# Developing the extension
+
+If you want to do code changes to the extension follow these simple steps to get going.
+
+1. Get Qlik Sense Desktop
+1. Create a new app and add the extension to a sheet.
+2. Clone the repository
+3. Run `npm install`
+4. Set the environment variable `BUILD_PATH` to your extensions directory. It will be something like `C:/Users/<user>/Documents/Qlik/Sense/Extensions/<extension_name>`.
+5. You now have two options. Either run the watch task or the build task. They are explained below. Both of them default to development mode but can be run in production by setting `NODE_ENV=production` before running the npm task.
+
+   a. **Watch**: `npm run watch`. This will start a watcher which will rebuild the extension and output all needed files to the `buildFolder` for each code change you make. See your changes directly in your Qlik Sense app.
+
+   b. **Build**: `npm run build`. If you want to build the extension package. The output zip-file can be found in the `buildFolder`.
+
 # Original Author
 
 **Michael Laenen**

src/qlik-network-chart.qext

@@ -1,9 +1,16 @@
 {
-	"name" : "Network Chart",
-	"description" : "NetWork Chart",
+	"name" : "Network chart",
+	"description" : "Network chart",
 	"icon" : "extension",
 	"type" : "visualization",
-	"version": "1.0",
+	"version": "X.Y.Z",
 	"preview" : "network.png",
-	"author": "Michael Laenen , agilos.com"
+	"keywords": "qlik-sense, visualization",
+	"author": "Michael Laenen <michael.laenen@agilos.com>",
+	"homepage": "",
+	"license": "MIT",
+	"repository": "",
+	"dependencies": {
+      "qlik-sense": ">=5.5.x"
+  }
 }