Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

3.1 KB
Raw Blame

OpenWA Dashboard

OpenWA Logo

Modern web dashboard for managing OpenWA WhatsApp API Gateway sessions, webhooks, and infrastructure.

✨ Features

  • Session Management - Create, monitor, and control WhatsApp sessions
  • QR Code Authentication - Real-time QR code display for device pairing
  • Webhook Configuration - Configure and test webhook endpoints
  • API Key Management - Generate and manage API keys
  • Infrastructure Monitoring - View system health and storage status
  • Real-time Updates - Live session status via WebSocket

πŸ› οΈ Tech Stack

Technology Purpose
React 19 UI Framework
TypeScript Type Safety
Vite 8 Build Tool
React Router 7 Client-side Routing
TanStack Query Server State Management
TanStack Table Data Tables
Socket.IO Client Real-time Communication
Lucide React Icons

πŸš€ Getting Started

Prerequisites

  • Node.js 22.22.2+ or 24.15+ (jsdom, used by the unit tests, requires it)
  • npm (the lockfile and the overrides security pins are npm-specific)

Development

# Install dependencies
npm install

# Start development server
npm run dev

Dashboard will be available at http://localhost:2886 (Vite dev server with hot reload; it proxies /api + /socket.io to the NestJS API on :2785).

In production the build (npm run build β†’ dist/) is served by the NestJS API itself on the same port via @nestjs/serve-static, so there is no separate dashboard container.

Production Build

# Build for production
npm run build

# Preview production build
npm run preview

πŸ“ Project Structure

dashboard/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/     # Reusable UI components
β”‚   β”œβ”€β”€ pages/          # Page components
β”‚   β”œβ”€β”€ hooks/          # Custom React hooks
β”‚   β”œβ”€β”€ services/       # API service layer
β”‚   β”œβ”€β”€ types/          # TypeScript definitions
β”‚   β”œβ”€β”€ utils/          # Utility functions
β”‚   β”œβ”€β”€ App.tsx         # Root component
β”‚   β”œβ”€β”€ App.css         # Global styles
β”‚   └── main.tsx        # Entry point
β”œβ”€β”€ public/             # Static assets
β”œβ”€β”€ index.html          # HTML template
└── vite.config.ts      # Vite configuration

πŸ”— API Connection

By default the dashboard calls the API on the same origin it is served from (the single-container setup), so no configuration is needed.

For a split-origin deployment (dashboard hosted separately from the API), set the API origin at build time β€” the /api prefix is appended automatically:

VITE_API_URL=http://localhost:2785
# real-time events (WebSocket) origin; defaults to VITE_API_URL, else the page origin
VITE_WS_URL=http://localhost:2785

πŸ“„ License

MIT License - Part of the OpenWA project.