neo4j-labs
diff --git a/‎.github/workflows/master-deployment.yml
Lines changed: 25 additions & 1 deletion b/‎.github/workflows/master-deployment.yml
Lines changed: 25 additions & 1 deletion
diff --git a/‎Dockerfile
Lines changed: 1 addition & 1 deletion b/‎Dockerfile
Lines changed: 1 addition & 1 deletion
diff --git a/‎README.md
Lines changed: 42 additions & 16 deletions b/‎README.md
Lines changed: 42 additions & 16 deletions
diff --git a/‎changelog.md
Lines changed: 16 additions & 0 deletions b/‎changelog.md
Lines changed: 16 additions & 0 deletions
diff --git a/‎cypress/fixtures/cypher_queries.js
Lines changed: 1 addition & 1 deletion b/‎cypress/fixtures/cypher_queries.js
Lines changed: 1 addition & 1 deletion
diff --git a/‎cypress/integration/start_page.spec.js
Lines changed: 6 additions & 1 deletion b/‎cypress/integration/start_page.spec.js
Lines changed: 6 additions & 1 deletion
diff --git a/‎docs/antora.yml
Lines changed: 1 addition & 1 deletion b/‎docs/antora.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎docs/modules/ROOT/nav.adoc
Lines changed: 1 addition & 0 deletions b/‎docs/modules/ROOT/nav.adoc
Lines changed: 1 addition & 0 deletions
diff --git a/‎docs/modules/ROOT/pages/developer-guide/build-and-run.adoc
Lines changed: 6 additions & 6 deletions b/‎docs/modules/ROOT/pages/developer-guide/build-and-run.adoc
Lines changed: 6 additions & 6 deletions
diff --git a/‎docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
Lines changed: 41 additions & 0 deletions b/‎docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
Lines changed: 41 additions & 0 deletions
@@ -57,6 +57,30 @@ jobs:
 #    - run: curl ${{ secrets.INDEX_HTML_DEPLOYMENT_URL }} > dist/index.html
 #    - run: aws s3 rm s3://neodash.graphapp.io/ --recursive && aws s3 sync dist s3://neodash.graphapp.io/ --acl public-read
  build-docker:
+   needs: build-test
+   runs-on: ubuntu-latest
+   strategy:
+     matrix:
+       node-version: [18.x]
+   steps:
+   - name: run Docker 
+     uses: actions/checkout@v2
+   - run: rm -rf docs
+   - name: Login to Docker Hub
+     uses: docker/login-action@v1
+     with:
+       username: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}
+       password: ${{ secrets.DOCKER_HUB_LABS_ACCESS_TOKEN }}
+   - name: Set up Docker Buildx
+     uses: docker/setup-buildx-action@v1
+   - name: Build and push
+     uses: docker/build-push-action@v2
+     with:
+      context: .
+      file: ./Dockerfile
+      push: true
+      tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_ACCESS_TOKEN }}/neodash:2.2.2
+ build-docker-legacy:
    needs: build-test
    runs-on: ubuntu-latest
    strategy:
@@ -79,7 +103,7 @@ jobs:
       context: .
       file: ./Dockerfile
       push: true
-      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.2.1
+      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.2.2
 #  build-npm:
 #    needs: build-test
 #    runs-on: ubuntu-latest
 
@@ -38,4 +38,4 @@ RUN chown -R nginx:nginx /usr/share/nginx/html/
 USER nginx
 EXPOSE 5005
 HEALTHCHECK cmd curl --fail http://localhost:5005 || exit 1
-LABEL version="2.2.1"
+LABEL version="2.2.2"
@@ -6,45 +6,71 @@ NeoDash is an open source tool for visualizing your Neo4j data. It lets you grou
 
 Neodash supports presenting your data as tables, graphs, bar charts, line charts, maps and more. It contains a Cypher editor to directly write the Cypher queries that populate the reports. You can save dashboards to your database, and share them with others.
 
-## Running NeoDash
+## Try NeoDash
 You can run NeoDash in one of three ways:
 
 1. You can install NeoDash into Neo4j Desktop from the [graph app gallery](https://install.graphapp.io). NeoDash will automatically connect to your active database.
 2. You can run NeoDash from a web browser by visiting http://neodash.graphapp.io.
 3. For on-prem deployments, you can build the application yourself, or pull the latest Docker image from Docker Hub.
 ```
 # Run the application on http://localhost:5005
-docker pull nielsdejong/neodash:latest
-docker run -it --rm -p 5005:5005 nielsdejong/neodash
+docker pull neo4jlabs/neodash:latest
+docker run -it --rm -p 5005:5005 neo4jlabs/neodash
 ```
 
 > Windows users may need to prefix the `docker run` command with `winpty`.
 
-See the [Developer Guide](https://neo4j.com/labs/neodash/2.1/developer-guide/) for more on installing, building, and running the application.
 
-## Coding practices
-In order to improve the code quality, we added a Prettier and a Linter to this repository.
 
-### Behavior
-While commiting, a pre-commit hook will be executed in order to prettify and run the Linter on your staged files. Linter warnings are currently accepted. The commands executed by this hook can be found in /.lintstagedrc.json.
+## Build and Run
+This project uses `yarn` to install, run, build prettify and apply linting to the code.
 
-There is also a dedicated linting step in the Github project pipeline in order to catch each potential inconsistency.
+To install dependencies:
+```
+yarn install
+```
+
+To run the application in development mode:
+```
+yarn run dev
+```
+
+To build the app for deployment:
+```
+yarn run build
+```
+
+To manually prettify all the project `.ts` and `.tsx` files, run:
+```
+yarn run format
+```
 
-**Don't hesitate to setup your IDE formatting feature to use the Prettier module and our defined rules (.prettierrc.json).**
+To manually run linting of all your .ts and .tsx files, run:
+```
+yarn run lint
+```
 
-### Manual execution
-If you want to **manually prettify all the project .ts and .tsx files**, you can run `yarn run format`.
+To manually run linting of all your .ts and .tsx staged files,  run:
+```
+yarn run lint-staged
+```
+
+See the [Developer Guide](https://neo4j.com/labs/neodash/2.2/developer-guide/) for more on installing, building, and running the application.
+
+### Pre-Commit Hook
+While commiting, a pre-commit hook will be executed in order to prettify and run the Linter on your staged files. Linter warnings are currently accepted. The commands executed by this hook can be found in /.lintstagedrc.json.
+
+There is also a dedicated linting step in the Github project pipeline in order to catch each potential inconsistency.
 
-If you wan to **manually run linting of all your .ts and .tsx files**, you can run `yarn run lint`.
+> Don't hesitate to setup your IDE formatting feature to use the Prettier module and our defined rules (.prettierrc.json).
 
-If you wan to **manually run linting of all your .ts and .tsx staged files**, you can run `yarn run lint-staged`.
 
 ## User Guide
 NeoDash comes with built-in examples of dashboards and reports. For more details on the types of reports and how to customize them, see the [User Guide](
-https://neo4j.com/labs/neodash/2.1/user-guide/).
+https://neo4j.com/labs/neodash/2.2/user-guide/).
 
 ## Publish Dashboards
-After building a dashboard, you can chose to deploy a read-only, standalone instance for users. See [Publishing](https://neo4j.com/labs/neodash/2.1/user-guide/publishing/) for more on publishing dashboards.
+After building a dashboard, you can chose to deploy a read-only, standalone instance for users. See [Publishing](https://neo4j.com/labs/neodash/2.2/user-guide/publishing/) for more on publishing dashboards.
 
 
 ## Questions / Suggestions
 
@@ -1,3 +1,19 @@
+## NeoDash 2.2.2
+The NeoDash 2.2.2 release is packed with a bunch of new usuability features:
+- Changed the built-in Cypher editor to a brand-new [CodeMirror Editor](https://github.com/neo4j-contrib/cypher-editor).
+- Rebuilt the **Parameter Select** component from scratch for improved stability, performance and extendability:
+  - Added an optional setting to the parameter selector to display a different property from the one that is set by the selector.
+  - Use this to - for example - let users choose a name and set an ID for use by other reports.
+  - Fields no longer reset randomly when parameters are changed.
+  - Freetext fields are no longer slow - perform as fast as the other selectors.
+- Add the option to use rule-based styling based on dashboard parameters.
+- Changed rule-based styling on bar and pie charts to override color scheme instead of clear the scheme.
+- Extended the [Example Gallery](https://neodash-gallery.graphapp.io/) with several new demos.
+- Adding intermediate report error boundaries for improved app stability. 
+- Changed docker image name to `neo4jlabs/neodash`.
+- Improved documementation for developers.
+- Fixed inconsistent styling between different pop-up screens, and fixed report title placeholders.
+
 ## NeoDash 2.2.1
 This update provides a number of usability improves over the 2.2.0 release.
 In addition, it entails various improvements to the codebase, including security patches on the dependencies.
 
@@ -47,6 +47,7 @@ describe('NeoDash E2E Tests', () => {
     cy.get('#dbpassword').type('test');
     cy.wait(100);
     cy.get('button').contains('Connect').click();
+    cy.wait(100);
   });
 
   it('initializes the dashboard', () => {
@@ -130,7 +131,11 @@ describe('NeoDash E2E Tests', () => {
 
   it('creates a single value report', () => {
     createReportOfType('Single Value', barChartCypherQuery);
-    cy.get('main .react-grid-item:eq(2) .MuiCardContent-root > div > div:nth-child(2) > span').contains('1,999');
+    cy.get('main .react-grid-item:eq(2) .MuiCardContent-root > div > div:nth-child(2) > span')
+      .invoke('text')
+      .then((text) => {
+        expect(text).to.be.oneOf(['1999', '1,999']);
+      });
   });
 
   it('creates a gauge chart report', () => {
 
@@ -1,6 +1,6 @@
 name: neodash
 version: 2.2
-title: NeoDash Documentation
+title: NeoDash
 start_page: ROOT:index.adoc
 nav:
   - modules/ROOT/nav.adoc
 
@@ -31,6 +31,7 @@
 ** xref:user-guide/faq.adoc[FAQ]
 * xref:developer-guide/index.adoc[Developer Guide]
 ** xref:developer-guide/build-and-run.adoc[Build & Run]
+** xref:developer-guide/deploy-a-build.adoc[Deploy a Build]
 ** xref:developer-guide/configuration.adoc[Configuration]
 ** xref:developer-guide/standalone-mode.adoc[Standalone Mode]
 ** xref:developer-guide/component-overview.adoc[Component Overview]
 
@@ -15,7 +15,7 @@ ____
 
 To run the application in development mode: 
 
-- clone this repository. 
+- https://github.com/neo4j-labs/neodash[clone this repository.]
 - open a terminal and navigate to the directory you just cloned. 
 - run `yarn install` to install the necessary dependencies. 
 - run `yarn run dev` to run the app in development mode. 
@@ -33,8 +33,8 @@ Pull the latest image from Docker Hub to run the application locally:
 
 ....
 # Run the application on http://localhost:5005
-docker pull nielsdejong/neodash:latest
-docker run -it --rm -p 5005:5005 nielsdejong/neodash
+docker pull neo4jlabs/neodash:latest
+docker run -it --rm -p 5005:5005 neo4jlabs/neodash
 ....
 
 ____
@@ -44,7 +44,7 @@ ____
 == Build Docker image
 
 A pre-built Docker image is available
-https://hub.docker.com/r/nielsdejong/neodash[on DockerHub]. This image
+https://hub.docker.com/r/neo4jlabs/neodash[on DockerHub]. This image
 is built using the default configuration (running in editor mode,
 without SSO).
 
@@ -84,7 +84,7 @@ metadata:
 spec:
   containers:
     - name: neodash
-      image: nielsdejong/neodash:latest
+      image: neo4jlabs/neodash:latest
       ports:
         - containerPort: 5005
 ....
@@ -103,4 +103,4 @@ spec:
       targetPort: 5005
     selector:
       project: neodash
-....
+....
@@ -0,0 +1,41 @@
+= Deploy a Build
+If you have a pre-built NeoDash application, you can easily deploy it on an any webserver.
+A NeoDash build is "just" a collection of HTML, CSS and JavaScript files, so it can run virtually anywhere.
+
+This guide walks you through the process of deploying a NeoDash build onto your own webserver.
+
+== 1. Prepare the files
+First, check that you have the correct files.
+We typically provide builds as either a zip file or tarball with the following naming convention: 
+`neodash-2.X.X.zip` or `neodash-2.X.X.tar.gz`.
+
+For zip files, open up the terminal and run:
+```bash
+unzip neodash-2.X.X.zip
+```
+
+For tar.gz files, open up the terminal and run:
+```bash
+tar -xf neodash-2.X.X.tar.gz
+```
+
+After running either of these, you should now have a folder `neodash-2.X.X` in the current directory.
+
+== 2. Edit Configuration (Optional)
+This is an optional step if you want to configure optional settings for your NeoDash deployment (e.g. SSO or standalone mode).
+
+1. Inside the folder you just unzipped, open up `config.json`. 
+2. Edit this file to modify your link:../configuration[Configuration] settings.
+3. Save the file.
+
+== 3. Move the tarball/zip to your webserver
+Finally, copy the files to the correct folder on your webserver.
+Depending on the webserver type and version, this could be different directory.
+As an example - to copy the files to an nginx webserver using `scp`:
+
+```bash
+scp neodash-2.2.2 username@host:/usr/share/nginx/html
+```
+
+NeoDash should now be visible by visiting your (sub)domain in the browser.
+ Can't see the application? Check that the webserver user has read-permissions on the files you copied into the HTML directory.