[C4GT Community]: Neo4J DB Integration

KDwevedi commented 3 months ago

Ticket Contents

Description

Setup an accompanying Neo4J integration for the markdown enhancer.

Goals

[ ] Setup a Dockerfile + compose file for a local Neo4J instance
[ ] Setup a Javascript driver for the Neo4J instance
- [ ] Setup the ability to read the database
- [ ] Setup the ability to create one of the example datasets for testing
[ ] Setup a visualisation
- [ ] We should be able to zoom into specific nodes.

Expected Outcome

Neo4J DB integration and visualisation that:

Updates dynamically when the DB is updated
Can zoom into specified nodes in the graph

Acceptance Criteria

[ ] Visualisation updates dynamically
[ ] Visualisation has zoom-in functionality

Implementation Details

Use docker to setup a local Neo4J instance Neo4J Docker docs Example Dockerfile:

FROM neo4j:latest

ENV NEO4J_apoc_export_file_enabled=true \
    NEO4J_apoc_import_file_enabled=true \
    NEO4J_apoc_import_file_use__neo4j__config=true \
    NEO4J_dbms_security_procedures_unrestricted=apoc.* \
    NEO4J_PLUGINS=apoc-extended \
    NEO4J_AUTH=neo4j/testingInstance

EXPOSE 7474 7687

Example compose file:

version: '3.8'
services:
  neo4j:
    build: ./database
    container_name: neo4j-instance
    environment:
      - NEO4J_AUTH=neo4j/testingInstance
    ports:
      - "7474:7474" # HTTP
      - "7687:7687" # Bolt
    volumes:
      - ./data:/data
      - ./logs:/logs
      - ./import:/var/lib/neo4j/import
      - ./plugins:/plugins
    restart: always

Use the JS driver to read the nodes. To setup the graph visualisation: neovis-js

Mockups/Wireframes

No response

Product Name

Bharat Sahaiyak

Organisation Name

SamagraX

Domain

No response

Tech Skills Needed

Docker, JavaScript

Mentor(s)

@KDwevedi

Complexity

High

Category

Database, Frontend

c4gt-community-support[bot] commented 3 months ago

Hi! Important Details - These following details are helpful for contributors to effectively identify and contribute to tickets.

Sub-Category - Please mention the sub-category if any for the ticket

Please update the ticket

vsvishalsharma commented 3 months ago

@KDwevedi shall I start working on this

KDwevedi commented 3 months ago

Yeah, please do @vsvishalsharma

Yash-Sajwan24 commented 3 months ago

@KDwevedi I understand the problem, and I believe I have the necessary skills. Could I have the opportunity to work on this?

aryangandhi05 commented 3 months ago

Hello @KDwevedi Sir I want to solve this issue, as i understand it, and i will give my 100% for solving this issue So please, can you assign me this?

BharatSahAIyak / kg-markdown-enhancer