Statux Internal Documentation
Welcome to the Statux internal documentation. This site contains everything you need to onboard, develop, operate, and troubleshoot the Statux platform.
Quick Links
| I want to... | Go to... |
|---|---|
| Get started as a new employee | Onboarding Guide |
| Set up my development environment | Environment Setup |
| Understand the codebase structure | Repository Overview |
| Learn API coding standards | API Coding Standards |
| Understand the database | Database Architecture |
| Deploy changes | CI/CD Overview |
| Fix a common issue | Troubleshooting |
| Review security practices | Security Overview |
Platform Overview
Statux is a status page monitoring and alerting platform consisting of:
| Product | Purpose | Tech Stack |
|---|---|---|
| Statux Pages | Public status pages | NestJS API + Static Web |
| Statux Alerts | Incident alerting | NestJS API + Flutter App |
| Statux Synthetics | Synthetic monitoring | NestJS API + Go Relay |
Repository Structure
statux/
├── statux-api/ # Backend APIs (NestJS monorepo)
├── statux-web/ # Frontend websites (Static HTML/CSS/JS)
├── statux-infra/ # Infrastructure (Terraform)
├── statux-app/ # Mobile app (Flutter)
├── statux-relay/ # Synthetic check agent (Go)
└── statux-docs/ # This documentation site
Getting Help
- Technical questions: Check the relevant section in these docs
- Bugs/Issues: File an issue in the appropriate GitHub repository
- Urgent production issues: Follow the Incident Response runbook
Employee Access Required
This documentation is restricted to Statux employees. If you're seeing an "Access Denied" message, contact your manager to have your account flagged as an employee.