Files
portal/README.md
T
sharang e7fd402d75
ci / shared (pull_request) Successful in 3s
ci / test (pull_request) Has been skipped
ci / e2e (pull_request) Has been skipped
ci / image (pull_request) Has been skipped
chore(domain): yourplatform.com → breakpilot.com
Apply the platform-domain decision (2026-05-18) to every README,
workflow, and config in this repo. 4 files updated.

Refs: M1.1
2026-05-18 22:08:11 +02:00

2.4 KiB

portal

Next.js 15 customer area + backstage.

Part of the Breakpilot Platform. For the big picture see platform/docs: Architecture · Infrastructure · Product Integration Spec · Implementation Plan

What this is

Next.js 15 customer area + backstage. Scaffolded under milestone M5.1. See platform/docs for the full architecture context.

Plane: Control Owner: @sharang Status: pre-alpha Linked milestone: M5.1

Run locally

# prerequisites: see CONTRIBUTING.md for tooling once code lands
make dev          # starts dependencies + this service on http://localhost:3000
make test         # unit + integration
make e2e          # only if this repo ships user-facing flows

Local secrets come from .env.local (gitignored). Template at .env.example.

Endpoints / surface

{{For services: list the top-level routes or commands. For libraries: list the public API entry points. For IaC: list the make targets.}}

Deployment

Env URL How
dev http://localhost:3000 make dev
stage https://portal.stage.breakpilot.com auto on merge to main
prod https://portal.breakpilot.com manual: tag vX.Y.Z + sign-off

Rollback: orca rollout undo portal --env={{env}}.

Observability

  • Traces, logs, metrics: SigNoz — service name portal
  • Audit events: Tenant Registry /audit (Retraced-shape schema)
  • On-call: oncall@breakpilot.com · runbook at platform/docs/runbooks/portal.md

Contributing

See CONTRIBUTING.md. TL;DR: branch from main, open a PR, 1 review + green CI, squash-merge.

License

Proprietary — all rights reserved. Copyright (c) 2026 Sharang Parnerkar and Benjamin Boenisch. See LICENSE.