Files

copilot-swe-agent[bot] 702ae7eaea Fix cross-directory link paths and remove incorrect status markers

- Fix relative paths for cross-directory links (../ops/, ../services/, etc.)
- Remove _(planned)_ markers from services that actually exist
- Remove confusing _(reference CONTRIBUTING.md)_ comments
- All links now properly reference correct paths
- Build still passes successfully

Co-authored-by: blackboxprogramming <118287761+blackboxprogramming@users.noreply.github.com>

2025-11-24 16:44:52 +00:00

2.4 KiB

Raw Blame History

id, title, slug, description, tags, status

title

slug

description

Service: Web

What it does

The BlackRoad OS Web is the user-facing web application providing:

User interface for BlackRoad OS
Agent management dashboard
Job submission and monitoring
Real-time updates and notifications
Integration with API service

Repository

GitHub: BlackRoad-OS/blackroad-os-web
Primary Language: TypeScript (React/Next.js)
Framework: Next.js with App Router

Key Features

⚡ Server-side rendering with Next.js
🎨 Modern, responsive UI
🔄 Real-time updates via WebSockets
🔐 PS-SHA∞ authentication
📱 Mobile-friendly design

Architecture

flowchart LR
    User[User Browser] --> Web[Web Service]
    Web --> API[API Service]
    Web --> WS[WebSocket]
    WS --> Events[Event Stream]

Deployment

The Web service is deployed using:

Platform: Vercel / Railway
CDN: Cloudflare (for static assets)
Environment Variables: See .env.example in repository

For deployment procedures, see:

Infra Guide
Deploy Web Runbook (planned)

Key Routes

/ - Home page
/dashboard - User dashboard
/agents - Agent management
/jobs - Job monitoring
/settings - User settings

Environment Configuration

Key environment variables:

NEXT_PUBLIC_API_URL - API service URL
NEXT_PUBLIC_WS_URL - WebSocket URL
AUTH_SECRET - NextAuth secret
DATABASE_URL - Database for sessions (if applicable)

⚠️ Security: Never commit actual values. Use Vercel/Railway secrets.

Development

Local development:

# Clone the repository
git clone https://github.com/BlackRoad-OS/blackroad-os-web.git
cd blackroad-os-web

# Install dependencies
npm install

# Set up environment
cp .env.example .env.local
# Edit .env.local with local values

# Run development server
npm run dev

Visit http://localhost:3000

Service: API - Backend API
Service: Prism Console - Operational dashboard

2.4 KiB Raw Blame History