Repository files navigation

Cloud-express is an innovative web application that aims to bridge the gap between users and Apache Age, a cutting-edge database management system. With Cloud-express, users can now access Apache Age online through a user-friendly web interface. Gone are the days of offline access – Cloud-express offers a seamless experience, allowing users to harness the power of Apache Age's advanced capabilities directly from their web browsers.

This is a sub-project ofthe Apache AGE project.

• Node version - ^14.16.0

• Node Module - pm2

Install latestpm2 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 Cloud express.

• To run frontend:Install the required node modules using :
  npm run setup
• Run cloud-express frontend using :npm run start
• To run Backendusenode index.js in backend folder

This will start the Cloud-express frontend onhttp://localhost:3000 and backend onhttp://localhost:4000 if these ports are free.

• 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 Cloud express

• To start using Cloud express 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 usingDocker

  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 (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 localhostand put inpostgresPW when prompted for password.

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

Initial Connection Layout

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.

Cloud express is also licensed under the Apache License, Version 2.0 same as Apache AGE Viewer. See LICENSE for the full license text.