Skip to main content

Publishing

This page is mainly for maintainers of the package.

Pre-Publish Checklist​

Run tests:

npm test

Build the bundled frontend:

npm run build

Check the package contents:

npm pack --dry-run

Or run the combined check:

npm run pack:check

Smoke Test​

Create a separate Express project and install the local tarball:

npm pack
mkdir ../pg-dashboard-smoke-test
cd ../pg-dashboard-smoke-test
npm init -y
npm install express dotenv pg
npm install ../pg-dashboard/pg-dashboard-0.1.0.tgz

Create server.js:

require("dotenv").config();

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

const app = express();

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

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

Then run:

node server.js

Publish​

npm login
npm publish