commit	737f96e90d8b55ec9d4cf0d6527613325a776237	[log] [tgz]
author	Moontasir Mahmood <53787290+Munmud@users.noreply.github.com>	Sat Jan 28 03:28:11 2023 +0600
committer	GitHub <noreply@github.com>	Fri Jan 27 13:28:11 2023 -0800
tree	eae2445e0146c3699e7097b716d19ed5148191d5
parent	52a31bc7925b6a3f6069eb9816ce0e53f4139919 [diff]

tree: eae2445e0146c3699e7097b716d19ed5148191d5

README.md

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 variables Description
--name Assign a name to the container
-p Publish a container’s port(s) to the host
-e Set environment variables
-d Run 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.

Docker variables	Description
`--name`	Assign a name to the container
`-p`	Publish a container’s port(s) to the host
`-e`	Set environment variables
`-d`	Run container in background and print container ID

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.