Skip to content

Documentation Structure

📖 Documentation Structure

Security

Security, authentication and authorization patterns:

  • Session management with Redis
  • OAuth2/OIDC with Keycloak
  • JWT token validation
  • Role-based access control (RBAC)

Architecture

Application design and patterns:

  • CQRS with Mediator pattern
  • Dependency injection with Neuroglia
  • Controller design patterns
  • Repository pattern implementation

Frontend

UI development and build process:

  • Parcel bundler configuration
  • Nunjucks template system
  • JavaScript module architecture
  • SCSS compilation

Infrastructure

Environment setup and deployment:

  • Docker Compose stack
  • Service configuration
  • MongoDB setup
  • Redis configuration
  • Observability with OpenTelemetry

Development

Developer workflows and tools:

  • Makefile command reference
  • Testing strategies
  • Code quality tools
  • Contribution guidelines

Troubleshooting

Common problems and solutions:

  • Known issues and workarounds
  • Framework bugs and fixes
  • Environment debugging
  • Build troubleshooting