rockacola / pg-dashboard

Web-based client for PostgreSQL databases

pg-dashboard

Web-based client for PostgreSQL databases written in JavaScript.

Overview

pg-dashboard is a web-based PostgreSQL client, written in JavaScript and works on macOS, Linux, and Windows machines. The project was created to illustrate the possibility to roll out a portable application on your work works with both local or remote PostgreSQL databases.

Getting Started

System Recommendation

• Postgres 10+
• node.js 14.16+
• yarn (optional)

Installation

Create a clone of the repository

$ git clone https://github.com/rockacola/pg-dashboard.git

Server Setup

Install required node.js packages

$ yarn install

Client Setup

Install required node.js packages

$ yarn install

Usage

Server Usage

$ cd server/
$ yarn debug

Or to run as a production environment:

$ cd server/
$ yarn start

Client Usage

Create a copy of the environment variable file.

cd client/
cp .env.template .env

Update the configuration details.

$ cd client/
$ yarn start

Test

Server Testings

Create a copy of the environment variable file for testing.

cd server/
cp .env.test.template .env.test

Update the configuration details to suit your hosting need.

Client Testings

TBA

Feedback

Please open an issue if you want to leave feedback.

License

Open-source MIT.