Developer Guide

This documentation pertains to the unsupported version of NeoDash, as part of Neo4j Labs. For users of the supported NeoDash offering, refer to NeoDash commercial.

This guide contains information for developers looking to deploy NeoDash, or extend it for their own needs.

Build & Run
Configuration
Standalone Mode
Component Overview
Design
Style Configuration
Adding Visualizations
State Management
Testing
Contributing

Prerequisites for extending NeoDash

NeoDash is a web application written in TypeScript. Knowledge of React & Redux is also highly recommended when extending the application. Concretely, the following languages and frameworks make up the core of NeoDash:

React
Redux
Redux Thunks
Cypress
Material UI
Webpack

The following core libraries are used to build the visualizations for reports:

react-force-graph (Graph)
@mui/datagrid (Table)
@nivo (Bar, Line, Pie charts)
leaflet (Map)
react-markdown (Markdown)