|
| 1 | +## NeoDash Labs |
| 2 | +NeoDash is a dashboard builder for Neo4j, letting you build a graph dashboard in minutes. |
1 | 3 |
|
2 | | -## NeoDash Labs - Neo4j Dashboard Builder |
| 4 | +**This project will be archived on August 31st, 2025.** If you'd like to continue building dashboards, you can: |
3 | 5 |
|
4 | | - |
| 6 | +1. [Upgrade](https://console-preview.neo4j.io/tools/dashboards) to Dashboards in the Neo4j Console (free for everyone). |
| 7 | +2. If you'd like to keep using NeoDash for free, you can fork this repository and [run NeoDash yourself](https://github.com/neo4j-labs/neodash/blob/master/about.md). |
| 8 | +3. If you're in need of a supported version of NeoDash, you can [purchase](https://neo4j.com/docs/neodash-commercial/current/#_getting_access_to_neodash_commercial) a NeoDash commercial license together with a Neo4j Enterprise license. |
5 | 9 |
|
6 | | -In September 2024 **Neo4j [announced](https://www.datanami.com/2024/09/04/neo4j-simplifies-graph-database-in-the-cloud/#:~:text=NeoDash%20is%20an%20open%20source,was%20open%20source%2C%20not%20supported) NeoDash is evolving into a fully supported dashboard builder, as part of the Neo4j product suite**. |
7 | | - |
8 | | -This project (NeoDash Labs) will still be available and contain experimental features, but will **not** have official support. If you're interested to get official support for NeoDash as part of a Neo4j License agreement, please reach out to your Neo4j contact person. |
9 | | - |
10 | | -## About NeoDash Labs |
11 | | -NeoDash is a web-based tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports. |
12 | | - |
13 | | -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. |
14 | | - |
15 | | -## Try NeoDash Labs |
16 | | -You can run NeoDash in one of three ways: |
17 | | - |
18 | | -1. You can install NeoDash Labs into Neo4j Desktop from the [graph app gallery](https://install.graphapp.io). NeoDash will automatically connect to your active database. |
19 | | -> Note: never versions of Neo4j Desktop do not support adding experimental graph apps such as NeoDash. |
20 | | -
|
21 | | -2. You can run NeoDash Labs from a web browser by visiting http://neodash.graphapp.io. |
22 | | -3. For on-prem deployments, you can build the application yourself, or pull the latest Docker image from Docker Hub. |
23 | | -``` |
24 | | -# Run the application on http://localhost:5005 |
25 | | -docker pull neo4jlabs/neodash:latest |
26 | | -docker run -it --rm -p 5005:5005 neo4jlabs/neodash |
27 | | -``` |
28 | | - |
29 | | -> Windows users may need to prefix the `docker run` command with `winpty`. |
30 | | -
|
31 | | - |
32 | | - |
33 | | -## Build and Run |
34 | | -This project uses `yarn` to install, run, build prettify and apply linting to the code. |
35 | | - |
36 | | -To install dependencies: |
37 | | -``` |
38 | | -yarn install |
39 | | -``` |
40 | | - |
41 | | -To run the application in development mode: |
42 | | -``` |
43 | | -yarn run dev |
44 | | -``` |
45 | | - |
46 | | -To build the app for deployment: |
47 | | -``` |
48 | | -yarn run build |
49 | | -``` |
50 | | - |
51 | | -To manually prettify all the project `.ts` and `.tsx` files, run: |
52 | | -``` |
53 | | -yarn run format |
54 | | -``` |
55 | | - |
56 | | -To manually run linting of all your .ts and .tsx files, run: |
57 | | -``` |
58 | | -yarn run lint |
59 | | -``` |
60 | | - |
61 | | -To manually run linting of all your .ts and .tsx staged files, run: |
62 | | -``` |
63 | | -yarn run lint-staged |
64 | | -``` |
65 | | - |
66 | | -See the [Developer Guide](https://neo4j.com/labs/neodash/2.3/developer-guide/) for more on installing, building, and running the application. |
67 | | - |
68 | | -### Pre-Commit Hook |
69 | | -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. |
70 | | - |
71 | | -There is also a dedicated linting step in the Github project pipeline in order to catch each potential inconsistency. |
72 | | - |
73 | | -> Don't hesitate to setup your IDE formatting feature to use the Prettier module and our defined rules (.prettierrc.json). |
74 | | -
|
75 | | - |
76 | | -## User Guide |
77 | | -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]( |
78 | | -https://neo4j.com/labs/neodash/2.3/user-guide/). |
79 | | - |
80 | | -## Publish Dashboards |
81 | | -After building a dashboard, you can chose to deploy a read-only, standalone instance for users. See [Publishing](https://neo4j.com/labs/neodash/2.3/user-guide/publishing/) for more on publishing dashboards. |
82 | | - |
83 | | - |
84 | | -## Questions / Suggestions |
85 | | -If you have any questions about NeoDash, please reach out to the maintainers: |
86 | | -- Create an [Issue](https://github.com/neo4j-labs/neodash/issues/new) on GitHub for feature requests/bugs. |
87 | | -- Connect with us on the [Neo4j Discord](https://neo4j.com/developer/discord/). |
88 | | -- Create a post on the Neo4j [Community Forum](https://community.neo4j.com/). |
89 | | - |
90 | | -> NeoDash Labs is a free and open-source tool developed by the Neo4j community - not an official Neo4j product. Use at your own risk! |
0 commit comments