# Boiler-Go

## Docs

- [Health check](https://mnah05-boiler-go-21-79.mintlify.app/api/health.md): Check the health status of the application and its dependencies
- [Worker ping](https://mnah05-boiler-go-21-79.mintlify.app/api/worker-ping.md): Enqueue a test task to verify worker is processing jobs
- [Worker status](https://mnah05-boiler-go-21-79.mintlify.app/api/worker-status.md): Get the current status of the worker and available queues
- [Architecture](https://mnah05-boiler-go-21-79.mintlify.app/architecture.md): Understand Boiler-Go's project structure, design patterns, and request flow
- [Background jobs](https://mnah05-boiler-go-21-79.mintlify.app/concepts/background-jobs.md): Learn how Boiler-Go processes asynchronous tasks using Asynq with Redis for reliable background job processing
- [Configuration](https://mnah05-boiler-go-21-79.mintlify.app/concepts/configuration.md): Learn how Boiler-Go manages application configuration using environment variables with validation and fail-fast behavior
- [Database pool](https://mnah05-boiler-go-21-79.mintlify.app/concepts/database-pool.md): Learn how Boiler-Go manages PostgreSQL connections using pgxpool for optimal performance and reliability
- [Graceful shutdown](https://mnah05-boiler-go-21-79.mintlify.app/concepts/graceful-shutdown.md): Learn how Boiler-Go implements graceful shutdown for both API and worker processes to prevent data loss and ensure clean termination
- [Logging](https://mnah05-boiler-go-21-79.mintlify.app/concepts/logging.md): Learn how Boiler-Go implements structured logging with zerolog for both console and file output
- [Docker deployment](https://mnah05-boiler-go-21-79.mintlify.app/deployment/docker.md): Deploy Boiler-Go using Docker and Docker Compose
- [Environment variables](https://mnah05-boiler-go-21-79.mintlify.app/deployment/environment-variables.md): Complete reference for all Boiler-Go configuration options
- [Production checklist](https://mnah05-boiler-go-21-79.mintlify.app/deployment/production-checklist.md): Comprehensive checklist to ensure your Boiler-Go deployment is production-ready
- [Database migrations](https://mnah05-boiler-go-21-79.mintlify.app/development/database-migrations.md): Manage database schema changes with golang-migrate
- [Running services](https://mnah05-boiler-go-21-79.mintlify.app/development/running-services.md): Run the API server and background worker services in development
- [Development setup](https://mnah05-boiler-go-21-79.mintlify.app/development/setup.md): Set up your local development environment for Boiler-Go
- [Testing](https://mnah05-boiler-go-21-79.mintlify.app/development/testing.md): Run and write tests for Boiler-Go applications
- [Introduction](https://mnah05-boiler-go-21-79.mintlify.app/introduction.md): A production-ready Go backend boilerplate with clean architecture, PostgreSQL, Redis, and background job processing
- [Config](https://mnah05-boiler-go-21-79.mintlify.app/packages/config.md): Environment configuration management with validation
- [Database](https://mnah05-boiler-go-21-79.mintlify.app/packages/db.md): PostgreSQL connection pool management with pgx
- [Handler](https://mnah05-boiler-go-21-79.mintlify.app/packages/handler.md): HTTP request handlers and routing with Echo
- [Logger](https://mnah05-boiler-go-21-79.mintlify.app/packages/logger.md): Structured logging with configurable output destinations
- [Middleware](https://mnah05-boiler-go-21-79.mintlify.app/packages/middleware.md): HTTP middleware for request logging and context management
- [Queue](https://mnah05-boiler-go-21-79.mintlify.app/packages/queue.md): Shared queue configuration and priority management
- [Scheduler](https://mnah05-boiler-go-21-79.mintlify.app/packages/scheduler.md): Task scheduling and enqueueing with Asynq
- [Tasks](https://mnah05-boiler-go-21-79.mintlify.app/packages/tasks.md): Shared task type constants for background job processing
- [Quick start](https://mnah05-boiler-go-21-79.mintlify.app/quickstart.md): Get your Boiler-Go backend running in under 5 minutes