<div align="center">
  <img alt="logo:Neomap" src="https://raw.githubusercontent.com/stellasia/neomap/master/public/icon.png" height="96" />
  <h2 align="center">neomap</h2>
  <p align="center">
    <a href="https://github.com/stellasia/neomap/actions"><img src="https://github.com/stellasia/neomap/workflows/Node%20CI/badge.svg" /></a>
    <a href="https://github.com/stellasia/neomap/releases/"><img src="https://img.shields.io/github/release/stellasia/neomap.svg" /></a>
    <a href="https://github.com/Naereen/StrapDown.js/graphs/commit-activity"><img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
  </p>
</div>

A Neo4J Desktop (React-based) application to visualize nodes with geographical attributes on a map.

## Installation

### Add the app to Neo4jDesktop

#### From tarball

1. Go to the repository [releases](https://github.com/stellasia/neomap/releases)
2. Download the `neomap-<version>.tar.gz`
3. Open neo4j desktop and go to "Graph Applications" view:

   ![](img/desktop_graphapp_install.png)

4. Drag and drop the tarball you downloaded earlier below "Install Graph Application"
5. Trust the application
6. The application is now available and you can add it to your projects:

   ![](img/desktop_graphapp_add.png)

7. Click "Add"

   ![](img/desktop_graphapp_add_2.png)

## Usage

Read the [tutorial](https://github.com/stellasia/neomap/wiki/NeoMap-Tutorial/) or the [FAQ](https://github.com/stellasia/neomap/wiki/FAQ).

## Want to contribute?

See [CONTRIBUTING.md](CONTRIBUTING.md).

### WARNING

I am a data scientist, not a front-end developer. If someone with expertise with React wants to take a look and suggest improvements, that would be very welcome!

### Developer mode

1.  Clone this repo

2.  Install dependencies:

        npm install

3.  Start the development server:

        npm run start

4.  Configure Neo4jDesktop by enabling the development mode in settings with the following parameters:

    - Entry point: `http://localhost:3000`
    - Root path: root of this repository

5.  Run tests: install dev dependencies and

        npm run test

### Build for release (TODO: add this to CI?)

1. Make sure the version in package.json is correct
2. Build:

    npm run build

3. Create tgz package:

    npm pack

    
