The web client for the pgEdge AI DBA Workbench provides a browser-based interface for cluster monitoring and management.

For complete documentation, visit docs.pgedge.com.

• Features
• Prerequisites
• Getting Started
• Building
• Testing
• Configuration
• Documentation

The client provides the following capabilities:

• The application uses React with TypeScript for type safety and maintainability.
• Hierarchical monitoring dashboards display estate, cluster, server, and database metrics.
• The cluster navigator shows servers with color-coded replication edges.
• The AI chat interface supports natural language queries through multiple LLM providers.
• The administration panel manages users, groups, tokens, probes, and alert rules.
• Light and dark themes persist across browser sessions.

Before starting development, install the following tools:

• Node.js 20.19 or later on the 20.x line, or Node.js 22.12 or later.
• npm 9 or later.

Install the project dependencies:

npm install

Start the development server:

npm run dev

The application starts at http://localhost:5173 by default.

Create a production build with the following command:

npm run build

The build process generates output in the dist directory.

Run the test suite with the following command:

npm test

Run tests in watch mode for development:

npm run test:watch

Generate a coverage report:

npm run test:coverage

The development server proxies API requests to the MCP server running on port 8080. Configure the proxy in vite.config.js if the server runs on a different port.

For detailed documentation, see the Developer's Guide.

To report an issue with the software, visit: GitHub Issues

We welcome your project contributions; for more information, see docs/developer-guide/contributing.md.

For more information, visit docs.pgedge.com.

This project is licensed under the PostgreSQL License.