Documentation

Contents

• Architecture Overview — System design, layer architecture, key design decisions
• API Documentation — REST endpoints, request/response formats, error codes
• Setup Instructions — Local development environment setup
• Deployment Instructions — Docker, TrueNAS, production deployment
• CI/CD Pipeline — GitHub Actions workflows, checks, and deployment
• GitHub Pages — Documentation and security report publishing
• Testing Instructions — Running tests, test structure, writing new tests
• Security Notes — Security considerations, scanning tools, vulnerability policy
• Troubleshooting & FAQ — Common issues and frequently asked questions

Quick Links

• Interactive API Docs: http://<host>:<port>/docs (Swagger UI)
• Alternative API Docs: http://<host>:<port>/redoc (ReDoc)
• Health Check: http://<host>:<port>/health
• GitHub Pages: https://gicsei.github.io/BAB/