AGViewer

September 11, 2025 ยท View on GitHub

Web-based user interface that provides visualization of graph data stored in an AgensGraph database. It can render complex nodes, relationships, and properties in a clear and dynamic way. AGViewer helps developers, data analysts, and researchers gain deeper insights into graph data.

Features

  • Web-Based Interface: Accessible through any web browser.
  • Graph Visualization: Provides interactive visualization tools for graph data.
  • User-Friendly: Intuitive interface designed for ease of use.
  • Real-Time Interaction: Allows for real-time data updates and interaction with graph data.

This is a sub-project of AgensGraph

AGViewer via Docker image

  • Pulling the image:
docker pull skaiworldwide/agviewer
  • Run the container:
docker run --name agviewer -p 3000:3000 -d skaiworldwide/agviewer

Then open the URL 127.0.0.1:3000 on your browser.

Tip: if your AgensGraph server is running on your host machine or difference container, the URL to connect to it should be "host.docker.internal".

pm2 is an NPM module to run the project in production mode.

AGViewer via Source Code

1. Clone the Repository

Clone the AGViewer repository to your local machine:

git clone https://github.com/skaiworldwide-oss/AGViewer.git

2. Navigate to the Project Directory

Move into the cloned project directory:

cd AGViewer

3. Install Root Dependencies

Install the required Node.js dependencies for the root project:

npm install

4. Install Frontend Dependencies

Navigate into the frontend folder and install its dependencies:

cd frontend
npm install

If you encounter dependency errors during installation, try reinstalling Node.js and use the following command:

npm install --legacy-peer-deps

This command forces npm to ignore strict peer dependency checks and install all required packages.

5. Install Backend Dependencies

Install backend dependencies:

cd backend
npm install

Running the Application

  1. Return to the project root directory:
cd ..
  1. Start the application:
npm run start
  1. Open your browser and navigate to: http://localhost:3000

Connecting to AgensGraph

For AGViewer to function correctly, ensure that AgensGraph is running on your system.

Refer to this guide for help with setting up AgensGraph:
Setting up AgensGraph and AGViewer with Docker

Troubleshooting

  • If you face errors during npm install, reinstall Node.js, delete node_modules and package-lock.json
  npm install --legacy-peer-deps

  • Ensure that AgensGraph is running and accessible before starting AGViewer.

  • Make sure no other application is using port 3000.

For Windows Desktop Application

  • Run this inside app folder
yarn install
  • Run this for the application to launch
yarn run bundle:test

Documentation

Comprehensive documentation is available to help you get started with AGViewer and make the most of its features.

License