Google Git
Sign in
apache / age-viewer / refs/heads/main
commit8a7f0be2513e2aa4b2caf3d9833f4e2707f0001d[log] [tgz]
authorEmmanuel Allison <emmanuelallison@outlook.com>Fri Mar 22 01:12:08 2024 +0100
committerGitHub <noreply@github.com>Thu Mar 21 17:12:08 2024 -0700
tree78dd428f7ad9c477b52cb966f68e25334f16f874
parentf557486e99bec8df7d1581d8e27a0a57374b301d [diff]
Fix Metadata Load Error in PG v13, v14 and v15 (#154)

* add: meta_data.sql for PostgreSQL 13

* add: meta_data.sql for PG14 nd PG15
3 files changed
tree: 78dd428f7ad9c477b52cb966f68e25334f16f874
  1. .github/
  2. backend/
  3. frontend/
  4. .asf.yaml
  5. .dockerignore
  6. .gitattributes
  7. .gitignore
  8. DISCLAIMER
  9. Dockerfile
  10. ecosystem.config.js
  11. LICENSE
  12. NOTICE
  13. package-lock.json
  14. package.json
  15. README.md
README.md

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 (https://www.docker.com/get-started), 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=postgresPW -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 (There are two ways this can be done) -

    • First get into docker shell using - docker exec -it myPostgresDb bash
      Then get into postgreSQL shell using - psql -U postgresUser postgresDB

    OR

    • Alternatively postgres shell can also be assessed directly (without getting into the docker shell) - psql -U postgresUser -d postgresDB -p 5455 -h localhost and put in postgresPW when prompted for password.

  • 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.

License

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