This directory contains detailed usage guides and examples for all template features.
Complete guide for ESLint and Prettier setup with IDE integration for:
- VSCode configuration
- WebStorm configuration
- Pre-commit hooks
- npm scripts for linting and formatting
- CI/CD integration
- Troubleshooting
Complete guide for using the environment-aware rate limiting system with examples for:
- Authentication endpoints
- File uploads
- API endpoints
- Custom rate limiters
- Redis configuration
- Testing and monitoring
Guide for building offset and cursor pagination with pagi-help/v2 through the shared service-layer utility.
Guide for the package-backed uploads, SMS, mail, PDF, and pagination patterns that the template expects contributors to reuse.
Runner, generator, and repository guidance for persistent schema changes.
Repository architecture plus the additive harness-engineering layer for Codex.
Human and Codex app workflow, including worktree usage.
Baseline verification rules and repository quality scoring.
Repository and Codex operating constraints for safer changes.
Deterministic setup and operational guidance for worktrees and CI.
Local OTLP, logs, metrics, traces, and query workflows for backend development.
Instructions for configuring Codex app local environments and project actions.
Overview of the OpenTelemetry bootstrap hook and how it connects to the local observability stack.
Additional documentation will be added for:
- Authentication & Authorization (JWT + Casbin)
- Request Validation (Joi schemas)
- Database Operations (Sequelize transactions)
- Code Generation (Plop templates)
- File Uploads (AWS S3 integration)
- Email Notifications
- Error Handling
- Logging
For general overview and quick start, see the main README.
Also available: