OpsWarden documentation¶
OpsWarden is a real-time incident and release coordination platform. This site explains how to run it, reason about it and change it without having to read the repository from top to bottom.
-
Getting started
Start the full stack or an individual client, then verify the services.
-
Architecture
Follow one dependency rule from the domain to HTTP, PostgreSQL and WebSocket.
-
Integrate with it
Use the REST surface and the versioned real-time event contract.
-
Build consistent interfaces
Apply the product tokens, component rules and accessibility contract.
Documentation map
| If you want to… | Start here |
|---|---|
| run or demo the product | Get started |
| locate business logic | Architecture |
| understand persisted relations | Data model |
| consume real-time events | WebSocket protocol |
| create or review UI | UI guidelines |
| submit a safe change | Contributing |