baryon: A JavaScript repository from raghavchalapathy

Baryon is a react component to compose organized ui view for your neo4j graph that allows you to inspect simply and intuitively. This enables users to explore further relations from one node to another.

-> Link to Youtube Video

Features

Baryon provides you a simple ui to inspect neo4j graph data
Subject node appears in the main area
Relationships appear in a list
Each relationship is expressed in sentence powered by RDF triple
Each node or relationship can have start-date and end-date
Relationships are sorted by start-date of relationships, then start-date of nodes
Secondary relationships on each connected node is listed below the node
Secondary relationship list can be configured to be On / Off
Each node-label has their node-label-properties
Relations are categorized depending on relationship-types
- Each node-label-property is a collection of relationship-types
- ex: Both BROTHER_OF and SISTER_OF go into sibling node-label-property
URL path to Baryon ui on your app can be configured

Steps to Run sample app

Create your neo4j sandbox
Import sampledata.txt into your neo4j sandbox
git clone this project

$ git clone git@github.com:euonymus/baryon.git
$ cd baryon

Setup your neo4j connection in .env.local

sample .env.local settings

# neo4j connection
REACT_APP_NEO4J_URI=bolt://100.26.232.160:38283
REACT_APP_NEO4J_USER=neo4j
REACT_APP_NEO4J_PASSWORD=measurement-intakes-bells

Install node modules

$ npm install

Start npm project

$ npm start

How to Use sample app

Open http://localhost:3000 in your browser.
Enter "The Matrix" in the form. (In the case of you used sampledata.txt)
Go explore

How to implement Baryon into your React Application

Install Baryon as a node_module

# Configuring Bit as a scoped registry for NPM
$ npm config set '@bit:registry' https://node.bit.dev

# Install Baryon
$ npm i --save @bit/euonymus.baryon.baryon

In your React Application, call Baryon in JSX

import Baryon from '@bit/euonymus.baryon.baryon';

function App() {
  return (
    <Baryon quark_name="The Matrix"
            connection={{
              uri: 'bolt://100.26.232.160:38652',
              user: 'neo4j',
              password:'wingnuts-additives-lids'
            }}
	    graphPath={false} />
  );
}

Configurations

On and Off secondary relationship list

Set boolean hasSecondLevel props when you call Baryon Component in your JSX

function App() {
  return (
    <Baryon quark_name="The Matrix"
            connection={{
              uri: 'bolt://100.26.232.160:38652',
              user: 'neo4j',
              password:'wingnuts-additives-lids'
            }}
	    hasSecondLevel={false} />
  );
}

hasSecondLevel props configuration

hasSecondLevel props	Secondary Relationships
true	Secondary Relationships are shown
false	No Secondary Relationships

Set URL path to baryon ui on your app

You can configure the path to the baryon ui by setting graphPath props.

for example, if you set graphPath like this

function App() {
  return (
    <Baryon quark_name="The Matrix"
            connection={{
              uri: 'bolt://100.26.232.160:38652',
              user: 'neo4j',
              password:'wingnuts-additives-lids'
            }}
	    graphPath="/graph" />
  );
}

Each link to other node in baryon component will point to following path

/graph/{node-name}

graphPath props configuration

graphPath props	URL
false	No URL change
string	/{path to string}/{node-name}
empty string	/{node-name}

Data Structure

Actionable node properties

property	explanation	example
name	Japanese node name	ピコ太郎
en_name	English node name	Pikotaro
description	Japanese Explanation	ピコ太郎は日本のコメディアン
en_description	English Explanation	Pikotaro is a Japanese comedian, television personality and entertainer
image_path	Image URL	https://ilyricsbuzz.com/wp-content/uploads/2016/10/Pen-Pineapple-Apple-Pen.jpeg
start	Start date of the node	1973-07-17
end	End date of the node	2080-07-17
start_accuracy	year / month / null are allowed	month
end_accuracy	year / month / null are allowed	year
is_momentary	Flag of if the node lifetime is momentary	false
url	Official URL of the Node	https://avex-management.jp/artists/talent/TKDMA

Sorry for the inconvenience caused by property name and en_name. The reason why I did this was, I needed to deal with my pre-existed Japanese data at first.

Actionable relationship properties

property	explanation	example
relation	Relation between nodes	was created by
start	Start date of the node	1973-07-17
end	End date of the node	2080-07-17
start_accuracy	year / month / null are allowed	month
end_accuracy	year / month / null are allowed	year
is_momentary	Flag of if the node lifetime is momentary	false

raghavchalapathy/baryon