docs consolidation work
This commit is contained in:
69
docs/modules/web/README.md
Normal file
69
docs/modules/web/README.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Web
|
||||
|
||||
**Status:** Implemented
|
||||
**Source:** `src/Web/`
|
||||
**Owner:** UI Guild
|
||||
|
||||
## Purpose
|
||||
|
||||
Web provides the Angular 17 single-page application (SPA) frontend for StellaOps. Delivers the user interface for vulnerability exploration, policy management, scan results, SBOM visualization, and administrative functions.
|
||||
|
||||
## Components
|
||||
|
||||
**Application:**
|
||||
- `StellaOps.Web` - Angular 17 application with TypeScript, routing, and component library
|
||||
|
||||
**Key Features:**
|
||||
- Dashboard and vulnerability overview
|
||||
- Container scan results and SBOM explorer
|
||||
- Policy editor and rule visualization
|
||||
- VEX statement review and approval workflows
|
||||
- Task pack execution monitoring
|
||||
- Admin console for configuration and user management
|
||||
|
||||
## Configuration
|
||||
|
||||
Angular configuration in `angular.json` and environment files.
|
||||
|
||||
Key settings:
|
||||
- Backend API URL (`STELLAOPS_BACKEND_URL`)
|
||||
- Authority OAuth/OIDC endpoints
|
||||
- Feature flags for module visibility
|
||||
- Telemetry and error reporting
|
||||
|
||||
## Build and Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
cd src/Web/StellaOps.Web
|
||||
npm install
|
||||
|
||||
# Development server
|
||||
npm start
|
||||
|
||||
# Production build
|
||||
npm run build
|
||||
|
||||
# Run tests
|
||||
npm test
|
||||
|
||||
# Run E2E tests (Playwright)
|
||||
npx playwright test
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Gateway (API access)
|
||||
- Authority (authentication and authorization)
|
||||
- All backend services (via Gateway routing)
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- Architecture: `./architecture.md` (if exists)
|
||||
- UI Module: `../ui/` (shared UI components)
|
||||
- Gateway: `../gateway/`
|
||||
- Authority: `../authority/`
|
||||
|
||||
## Current Status
|
||||
|
||||
Angular 17 application implemented with routing, authentication, and integration with backend services. Supports vulnerability exploration, scan results, SBOM visualization, and policy management. Playwright E2E tests configured.
|
||||
Reference in New Issue
Block a user