viewer tutorial/tip (#104)

Co-authored-by: <>
14 files changed
tree: f5570f5e64239dd39d7c13d0c308076039557ef1
  1. .github/
  2. backend/
  3. frontend/
  4. .asf.yaml
  5. .dockerignore
  6. .gitattributes
  7. .gitignore
  10. Dockerfile
  11. ecosystem.config.js
  13. NOTICE
  14. package-lock.json
  15. package.json

PRs Welcome

What is Apache-Age Viewer

Apache-Age Viewer is a web based user interface that provides visualization of graph data stored in a postgreSQL database with AGE extension. It is graph visualisation tool, for Apache AGE.

This is a sub-project of the Apache AGE project.

Recommend Node Version & install module

  • Node version - ^14.16.0

  • Node Module - pm2

Install latest pm2 with : npm i pm2

pm2 is an NPM module to run the project in production mode, and hence is optional for getting started with setting up development environment for Age-Viewer

Running Age-Viewer

  • Install the required node modules using :
    npm run setup
  • Run Age-Viewer using : npm run start

This will start the age-viewer on http://localhost:3000 if port 3000 is free.

How to build using command

  • Build the front-end : npm run build-front

  • Build the back-end : npm run build-back

  • Start the project in production mode :

    	pm2 stop ag-viewer-develop
    	pm2 delete ag-viewer-develop
    	pm2 start ecosystem.config.js

    How to start using Age-Viewer

  • To start using Age-Viewer we need to have a running postgreSQL database server with Apache Age Extension

    Setting up the PostgreSQL server with AGE extension

    • Easiest way for Windows, Mac-OS and Linux Environment using Docker

    Install docker in advance (, install the version compatible with your OS from the provided link.

    Run Using Docker :

    • Get the docker image - docker pull apache/age

    • Create AGE docker container

      	docker run --name myPostgresDb -p 5455:5432 -e POSTGRES_USER=postgresUser -e POSTGRES_PASSWORD=pos  
      	tgresPW -e POSTGRES_DB=postgresDB -d apache/age
    Docker variablesDescription
    --nameAssign a name to the container
    -pPublish a container’s port(s) to the host
    -eSet environment variables
    -dRun container in background and print container ID
  • To Get the running log of the docker container created - docker logs --follow myPostgresDb

  • To Get into postgreSQL Shell - docker exec -it myPostgresDb bash

  • After logging into postgreSQL shell follow the Post-Installation instruction to create a graph in the database.

Connect Apache Age-Viewer to PostgreSQL Database

Initial Connection Layout enter image description here To Connect to postgreSQL server running from Docker Container

  • Connect URL - localhost
  • Connect Port - 5455
  • Database Name - postgresDB
  • User Name - postgresUser
  • Password - postgresPW

The following field is same as used to make the docker container specified above as flags.


Apache AGE Viewer is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.