feat(dashboard): admin dashboard

Author: vm-001

.github/workflows/lint.yml

@@ -25,3 +25,22 @@ jobs:
         with:
           version: v2.11
           only-new-issues: true
+
+  ui-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+          cache-dependency-path: ui/package-lock.json
+
+      - name: install dependencies
+        working-directory: ui
+        run: npm ci
+
+      - name: eslint
+        working-directory: ui
+        run: npm run lint

.github/workflows/test.yml

@@ -95,3 +95,18 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
           flags: integration-o11
+
+  test-ui:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+          cache-dependency-path: ui/package-lock.json
+      - name: install dependencies
+        working-directory: ui
+        run: npm ci
+      - name: runs ui tests
+        run: npm --prefix ui run test:run

.gitignore

@@ -3,7 +3,6 @@
 coverage.*
 webhookx
 *.log
-dist/
 test/output
 **/node_modules/
 **/rust/target/

AGENTS.md

@@ -0,0 +1,9 @@
+# AGENTS.md
+
+This file provides guidance to AI coding assistants when working with code in this repository.
+
+## Project Overview
+
+
+## UI
+

CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

Dockerfile

@@ -1,13 +1,24 @@
+FROM node:24-alpine AS ui
+
+WORKDIR /webhookx
+
+COPY ui/package.json ui/package-lock.json ./ui/
+RUN npm --prefix ui ci
+
+COPY openapi.yml ./openapi.yml
+COPY ui/ ./ui/
+RUN npm --prefix ui run build
+
 FROM golang:1.26.5 AS build-env
 
 WORKDIR /go/src/webhookx-io/webhookx
 
 COPY api/license api/license
-COPY go.mod /go/src/webhookx-io/webhookx
-COPY go.sum /go/src/webhookx-io/webhookx
+COPY go.mod go.sum ./
 RUN go mod download
 
-COPY . .
+COPY --exclude=ui/dist . .
+COPY --from=ui /webhookx/ui/dist ./ui/dist
 RUN make build
 
 FROM alpine:3.22
@@ -17,6 +28,7 @@ COPY --from=build-env /go/src/webhookx-io/webhookx/webhookx /usr/local/bin
 EXPOSE 9600
 EXPOSE 9601
 EXPOSE 9602
+EXPOSE 9605
 
 
 CMD ["webhookx", "start"]

Makefile

@@ -10,6 +10,9 @@ LDFLAGS = --ldflags "\
 clean:
 	go clean
 	go clean -testcache
+	rm -rf ui/dist/*
+	mkdir -p ui/dist
+	touch ui/dist/.gitkeep
 
 build:
 	CGO_ENABLED=0 go build -o webhookx ${LDFLAGS} ./cmd/main

admin/api/api.go

@@ -63,7 +63,6 @@ func (api *API) json(code int, w http.ResponseWriter, data interface{}) {
 	response.JSON(w, code, data)
 }
 
-
 func (api *API) lookupOperation(path string, method string) *openapi3.Operation {
 	operation := openapi.Spec.Paths.Find(path).GetOperation(method)
 	if operation == nil {
@@ -151,6 +150,7 @@ func (api *API) Handler() http.Handler {
 
 	r.HandleFunc("/", api.Index).Methods("GET").Name("admin.root")
 	r.HandleFunc("/license", api.GetLicense).Methods("GET").Name("admin.license.get")
+	r.HandleFunc("/catalog", api.GetCatalog).Methods("GET").Name("admin.catalog")
 
 	r.HandleFunc("/workspaces/{workspace}/config/sync", api.Sync).Methods("POST").Name("admin.config.sync")
 	r.HandleFunc("/workspaces/{workspace}/config/dump", api.Dump).Methods("POST").Name("admin.config.dump")

admin/api/catalog.go

@@ -0,0 +1,40 @@
+package api
+
+import (
+	"net/http"
+
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/webhookx-io/webhookx/pkg/plugin"
+)
+
+type Catalog struct {
+	Plugins []CatalogPlugin `json:"plugins"`
+}
+
+type CatalogPlugin struct {
+	Name        string           `json:"name"`
+	Type        string           `json:"type"`
+	Description string           `json:"description"`
+	Schema      *openapi3.Schema `json:"schema"`
+}
+
+func (api *API) GetCatalog(w http.ResponseWriter, _ *http.Request) {
+	registrations := plugin.ListRegistration()
+	plugins := make([]CatalogPlugin, 0, len(registrations))
+
+	for _, registration := range registrations {
+		p := registration.Factory()
+		plugins = append(plugins, CatalogPlugin{
+			Name:        registration.Name,
+			Type:        string(registration.Type),
+			Description: p.Description(),
+			Schema:      p.ConfigSchema(),
+		})
+	}
+
+	catalog := &Catalog{
+		Plugins: plugins,
+	}
+
+	api.json(http.StatusOK, w, catalog)
+}

app/app.go

@@ -18,6 +18,7 @@ import (
 	"github.com/webhookx-io/webhookx/config"
 	"github.com/webhookx-io/webhookx/config/modules"
 	"github.com/webhookx-io/webhookx/constants"
+	"github.com/webhookx-io/webhookx/dashboard"
 	"github.com/webhookx-io/webhookx/db"
 	"github.com/webhookx-io/webhookx/db/dao"
 	"github.com/webhookx-io/webhookx/db/migrator"
@@ -184,6 +185,11 @@ func (app *Application) initialize() error {
 		return err
 	}
 
+	// dashboard
+	if err := app.initDashboard(&cfg.Dashboard); err != nil {
+		return err
+	}
+
 	// gateway
 	if err := app.initGateway(&cfg.Proxy, services, dispatcher, metrics); err != nil {
 		return err
@@ -287,6 +293,17 @@ func (app *Application) initAdmin(cfg *modules.AdminConfig, services *services.S
 	return nil
 }
 
+func (app *Application) initDashboard(cfg *modules.DashboardConfig) error {
+	if cfg.IsEnabled() {
+		dashboard, err := dashboard.NewDashboard(*cfg)
+		if err != nil {
+			return err
+		}
+		app.registerService(dashboard)
+	}
+	return nil
+}
+
 func (app *Application) initGateway(cfg *modules.ProxyConfig, services *services.Services, d *dispatcher.Dispatcher, metrics *metrics.Metrics) error {
 	if cfg.IsEnabled() {
 		opts := proxy.Options{
@@ -507,6 +524,7 @@ func (app *Application) Start() error {
 		fmt.Println("- Version:", utils.Colorize(webhookx.VERSION, utils.ColorDarkBlue, colored))
 		fmt.Println("- Proxy URL:", utils.Colorize(app.cfg.Proxy.URL(), utils.ColorDarkBlue, colored))
 		fmt.Println("- Admin URL:", utils.Colorize(app.cfg.Admin.URL(), utils.ColorDarkBlue, colored))
+		fmt.Println("- Dashboard URL:", utils.Colorize(app.cfg.Dashboard.URL(), utils.ColorDarkBlue, colored))
 		fmt.Println("- Status URL:", utils.Colorize(app.cfg.Status.URL(), utils.ColorDarkBlue, colored))
 		fmt.Println("- Worker:", utils.Colorize(app.cfg.Worker.Status(), utils.ColorDarkBlue, colored))
 		fmt.Println()
@@ -553,6 +571,7 @@ func (app *Application) Start() error {
 		app.getService("eventbus"),
 		app.getService("metrics"),
 		app.getService("admin"),
+		app.getService("dashboard"),
 		app.getService("worker"),
 		app.getService("proxy"),
 		app.getService("status"),
@@ -578,7 +597,7 @@ func (app *Application) stop(ctx context.Context) error {
 	defer func() { _ = app.log.Sync() }()
 
 	var errs []error
-	errs = append(errs, stopServices(ctx, time.Second*10, app.getService("proxy"), app.getService("admin"), app.getService("status")))
+	errs = append(errs, stopServices(ctx, time.Second*10, app.getService("proxy"), app.getService("admin"), app.getService("dashboard"), app.getService("status")))
 	errs = append(errs, stopServices(ctx, 0, app.getService("eventbus")))
 	errs = append(errs, stopServices(ctx, 0, app.getService("worker")))
 	errs = append(errs, stopServices(ctx, time.Second*5, app.getService("metrics"), app.getService("tracing")))