{"id":22485319,"url":"https://github.com/apache/age-viewer","last_synced_at":"2025-04-04T16:11:55.981Z","repository":{"id":45150027,"uuid":"397996130","full_name":"apache/age-viewer","owner":"apache","description":"Graph database optimized for fast analysis and real-time data processing. It is provided as an extension to PostgreSQL.","archived":false,"fork":false,"pushed_at":"2024-05-08T07:35:53.000Z","size":8606,"stargazers_count":283,"open_issues_count":81,"forks_count":244,"subscribers_count":27,"default_branch":"main","last_synced_at":"2025-03-28T15:05:36.374Z","etag":null,"topics":["age-database","analytics","graph-database","graphdb","multi-model-dbms","postgresql","postgresql-extension"],"latest_commit_sha":null,"homepage":"https://age.apache.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-19T15:49:10.000Z","updated_at":"2025-03-28T04:04:52.000Z","dependencies_parsed_at":"2024-03-22T01:26:23.934Z","dependency_job_id":"03bf220e-f34d-4445-8c1e-f4bc68f28fec","html_url":"https://github.com/apache/age-viewer","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fage-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fage-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fage-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fage-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/age-viewer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246989728,"owners_count":20865331,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["age-database","analytics","graph-database","graphdb","multi-model-dbms","postgresql","postgresql-extension"],"created_at":"2024-12-06T17:12:23.160Z","updated_at":"2025-04-04T16:11:55.952Z","avatar_url":"https://github.com/apache.png","language":"JavaScript","readme":"[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n  \u003ca href=\"https://github.com/apache/age/blob/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/apache/age-viewer\"/\u003e\n  \u003ca href=\"https://github.com/apache/age/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/apache/age-viewer\"/\u003e\n\u003c/p\u003e\n\n# What is Apache-Age Viewer\nApache-Age Viewer is a web based user interface that provides visualization of graph data stored in a postgreSQL database with AGE extension. \nIt is graph visualisation tool, for Apache AGE.\n\nThis is a sub-project of [the Apache AGE project](https://age.apache.org/#).\n\n# Recommend Node Version \u0026 install module\n\n- Node version - ^14.16.0\n\n- Node Module - pm2 \n\nInstall latest **pm2** with :\n``` npm i pm2 ```\n\n\n\u003e [pm2](https://www.npmjs.com/package/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 \n\n# Running Age-Viewer\n\n - Install the required node modules using  :  \n\t```npm run setup```\n- Run Age-Viewer using : \n```npm run start```\n\n\u003eThis will start the age-viewer on http://localhost:3000 if port 3000 is free.\n\n\n# How to build using command\n\n- Build the front-end : \n```npm run build-front ```\n\n- Build the back-end :\n``` npm run build-back```\n\n- Start the project in production mode :\n  ``` \n\tpm2 stop ag-viewer-develop\n\n\tpm2 delete ag-viewer-develop\n\n\tpm2 start ecosystem.config.js\n\n\t```\n\n  # How to start using Age-Viewer\n - To start using Age-Viewer we need to have a running postgreSQL database server with Apache Age Extension \n\t ### Setting up the PostgreSQL server with AGE extension\n\t-  Easiest way  for Windows, Mac-OS and Linux Environment using **Docker**\n  \n\t\u003e Install docker in advance (https://www.docker.com/get-started), install the version compatible with your OS from the provided link.\n\t\n\t **Run Using Docker** :\n   \n\t- Get the docker image - \n\t```docker pull apache/age ```\n\t\n\t- Create AGE docker container\n\t```bash\n\tdocker run --name myPostgresDb -p 5455:5432 -e POSTGRES_USER=postgresUser \\\n\t-e POSTGRES_PASSWORD=postgresPW -e POSTGRES_DB=postgresDB -d apache/age\n\t```\n\t\n\t| Docker variables| Description |\n\t|--|--|\n\t| ``--name`` | Assign a name to the container |\n\t|\t`-p` |\tPublish a container’s port(s) to the host|\n\t|\t``-e``|\tSet environment variables|\n\t|\t``-d``|\tRun container in background and print container ID|\n- To Get the running log of the docker container created - \n`` docker logs --follow myPostgresDb``\n- To Get into postgreSQL Shell (There are two ways this can be done) -\n\t- First get into docker shell using -\t`` docker exec -it myPostgresDb bash`` \n\t\u003cbr\u003eThen get into postgreSQL shell using - `` psql -U postgresUser postgresDB``\n\t\n\tOR\n\t\n\t- Alternatively postgres shell can also be assessed directly (without getting into the docker shell) -\n\t\t`` psql -U postgresUser -d postgresDB -p 5455 -h localhost``\n\t\tand put in ``postgresPW`` when prompted for password.\n- After logging into postgreSQL shell follow the [Post-Installation](https://github.com/apache/age#post-installation) instruction to create a graph in the database.\n### Connect Apache Age-Viewer to PostgreSQL Database\n**Initial Connection Layout**\n![enter image description here](https://user-images.githubusercontent.com/69689387/211624181-9644f489-1a45-4eed-ac8e-7aaf156b97ea.png)\nTo Connect to postgreSQL server running from Docker Container\n- Connect URL - localhost\n- Connect Port - 5455 \n- Database Name - postgresDB\n- User Name - postgresUser\n- Password - postgresPW\n\u003e The following field is same as used to make the docker container specified above as flags.\n\n\n\n# License\n\nApache AGE Viewer is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fage-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fage-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fage-viewer/lists"}