Installation

Install the package in your Express project:

npm install pg-dashboard

You also need Express in the host application:

npm install express

If your project does not already have pg, install it too:

npm install pg

Requirements

• Node.js 18 or newer
• Express 4 or Express 5
• PostgreSQL
• A valid PostgreSQL connection string or an existing pg pool

Basic Express Setup

const express = require("express");
const { pgDashboard } = require("pg-dashboard");

const app = express();

app.use(
  "/admin/db",
  pgDashboard({
    connectionString: process.env.DATABASE_URL,
    schemaName: "public",
  }),
);

app.listen(3000, () => {
  console.log("Dashboard running at http://localhost:3000/admin/db");
});

Environment Variables

A common .env file looks like this:

DATABASE_URL="postgres://postgres:password@localhost:5432/my_database"
PG_DASHBOARD_SCHEMA=public

Then use it in Express:

require("dotenv").config();

app.use(
  "/admin/db",
  pgDashboard({
    connectionString: process.env.DATABASE_URL,
    schemaName: process.env.PG_DASHBOARD_SCHEMA || "public",
  }),
);