Merge pull request #59 from lineupjs/develop

Release v4.0.0

.circleci/config.yml

@@ -1,37 +1,50 @@
 version: 2
 jobs:
  build:
- working_directory: ~/lineup
+ working_directory: ~/src
  docker:
- - image: circleci/node:8-browsers
+ - image: circleci/node:10-browsers
  steps:
  - checkout
  - restore_cache:
- key: deps3-{{ .Branch }}-{{ checksum "package.json" }}-{{ checksum "package-lock.json" }}
+ key: deps2-{{ checksum "package.json" }}-{{ checksum "package-lock.json" }}
  - run:
  name: install-npm-wee
  command: npm install
+ - run:
+ name: revert package-lock.json
+ command: git checkout package-lock.json
  - save_cache:
- key: deps3-{{ .Branch }}-{{ checksum "package.json" }}-{{ checksum "package-lock.json" }}
+ key: deps2-{{ checksum "package.json" }}-{{ checksum "package-lock.json" }}
  paths:
  - ./node_modules
+ - restore_cache:
+ key: deps2-e-{{ checksum "electron/package.tmpl.json" }}
  - run:
  name: dist
  command: npm run dist
+ - save_cache:
+ key: deps2-e-{{ checksum "electron/package.tmpl.json" }}
+ paths:
+ - ./electron/node_modules
  - store_artifacts:
  path: dist
  - run: #update build doc and readme
  name: update api
  command: |
- if [ "${CIRCLE_BRANCH}" == "master" ] ; then
- git clone git@github.com:datavisyn/lineup.js.org.git
- cd lineup.js.org
- rm -rf "app/"
- mv ../build "app"
- git config user.email "samuel_gratzl@gmx.at"
+ if [ "${CIRCLE_BRANCH}" == "master" ] || [ "${CIRCLE_BRANCH}" == "develop" ] ; then
+ git clone git@github.com:lineupjs/lineupjs.github.io.git
+ cd lineupjs.github.io
+ appdir=app
+ if [ "${CIRCLE_BRANCH}" == "develop" ] ; then
+ appdir=app_develop
+ fi
+ rm -rf "${appdir}/"
+ mv ../build "${appdir}"
+ git config user.email "sam@sgratzl.com"
  git config user.name "Samuel Gratzl"
  git add -A
- git commit -m "auto updating app" -m "trigger: ${CIRCLE_BUILD_URL}"
+ git commit -m "auto updating ${appdir}" -m "trigger: ${CIRCLE_BUILD_URL}"
  git push origin master
  fi
 

.release-it.json

@@ -0,0 +1,17 @@
+{
+ "hooks": {
+ "before:init": "npm test",
+ "before:release": "npm run dist",
+ "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
+ },
+ "git": {
+ "tagName": "v%s"
+ },
+ "npm": {
+ "publish": true
+ },
+ "github": {
+ "release": true,
+ "assets": ["dist/*.zip"]
+ }
+}

.stylelintrc

@@ -7,6 +7,7 @@
  "at-rule-no-unknown": null,
  "at-rule-empty-line-before": null,
  "block-closing-brace-newline-after": null,
+ "no-descending-specificity": null,
  "scss/at-rule-no-unknown": true,
  "scss/at-extend-no-missing-placeholder": true,
  "scss/at-else-closing-brace-newline-after": "always-last-in-chain",

README.md

@@ -1,38 +1,68 @@
 LineUp App
 ==========
 
-[![License: MIT][mit-image]][mit-url] [![CircleCI][ci-image]][ci-url] 
+[![License: MIT][mit-image]][mit-url] [![CircleCI][ci-image]][ci-url]  [![CircleCI][ci-image-dev]][ci-url-dev] <sup>(v4)</sup>
 
 LineUp is an interactive technique designed to create, visualize and explore rankings of items based on a set of heterogeneous attributes. 
-This is a demo application using [LineUp.js](https://github.com/datavisyn/lineupjs). Details about the LineUp visualization technique can be found at [http://lineup.caleydo.org](http://lineup.caleydo.org). 
+This is a demo application using [LineUp.js](https://github.com/lineupjs/lineupjs). Details about the LineUp visualization technique can be found at [http://lineup.caleydo.org](http://lineup.caleydo.org). 
 
-The application is deployed at: https://lineup.js.org/app
+The application is deployed at: https://lineup.js.org/app. The develop version using LineUp v4 is deployed at https://lineup.js.org/app_develop. It is a Single Pape Application that requires no server installation. No data is transfered to any server but just kept local in your browser local storage using [IndexedDB](https://developer.mozilla.org/de/docs/Web/API/IndexedDB_API).
 
-**Features**
- * CSV Import
- * CSV Export
- * JSON Export
- * CodePen Export
- * Github Gist Export
+![Start Page](./_readme/homepage.png)
 
-![Screenshot](https://user-images.githubusercontent.com/4129778/36336600-8590a932-1389-11e8-8de0-269079efc37b.png) 
+![Soccer dataset](./_readme/soccer.png)
+
+Features
+--------
+ * Data Management
+ * Choose one of the preloaded datasets
+ * Import/Export CSV File
+ * Import/Export JSON File
+ * Import/Export LineUp JSON Dump
+ * Session Management
+ save different analyses with a custom session name. A session represents a view on the current dataset along with the currently specified sorting, filtering, grouping, and so on.
+ * Export the current state to one of 
+ * https://codepen.io
+ * https://jsfiddle.net
+ * https://codesandbox.io
+
+**Note** Uploaded files are stored in your local web browser only.
 
 Supported Browsers
 ------------------
 
- * Chrome 64+ (best performance)
- * Firefox 57+
- * Edge 16+
+ * last 2 Chrome versions (best performance)
+ * last 2 Edge versions (best performance)
+ * last 2 Firefox versions
+ * Firefox [Extended Support Release](https://www.mozilla.org/en-US/firefox/enterprise/) (ESR)
+ * Edge 18
+
+
+Usage
+-----
+
+![Start Page](./_readme/homepage_annotated.png)
+
+![Soccer Dataset](./_readme/soccer_annotated.png)
 
 
+Hosting
+-------
+
+This app is a client only app. Thus, requires no server since all data is stored on the browser only. To host it onself: 
+
+1. build the app by following the development environemtn instructions and create a distribution package.
+1. copy the content of the `/build` directory to your target destination
+1. host the content through a web server such as NGINX or host it by running a local web server. A list of web servers can be found at https://gist.github.com/willurd/5720255. 
+
 
 Development Environment
 -----------------------
 
 **Installation**
 
 ```bash
-git clone https://github.com/datavisyn/lineup_app.git
+git clone https://github.com/lineupjs/lineup_app.git
 cd lineup_app
 npm install
 ```
@@ -62,11 +92,9 @@ Authors
 
  * Samuel Gratzl (@sgratzl)
 
- [mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
+[mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
 [mit-url]: https://opensource.org/licenses/MIT
-[ci-image]: https://circleci.com/gh/datavisyn/lineup_app.svg?style=shield
-[ci-url]: https://circleci.com/gh/datavisyn/lineup_app
-
-
-
-
+[ci-image]: https://circleci.com/gh/lineupjs/lineup_app.svg?style=shield
+[ci-url]: https://circleci.com/gh/lineupjs/lineup_app
+[ci-image-dev]: https://circleci.com/gh/lineupjs/lineup_app/tree/develop.svg?style=shield
+[ci-url-dev]: https://circleci.com/gh/lineupjs/lineup_app/tree/develop