Blueprint Documentation¶
Getting Started¶
Blueprint is a modular Go framework. Starting from v0.8.0, you can import only the components you need:
# Install core framework
go get github.com/oddbit-project/blueprint
# Install specific providers
go get github.com/oddbit-project/blueprint/provider/httpserver
go get github.com/oddbit-project/blueprint/provider/jwtprovider
go get github.com/oddbit-project/blueprint/provider/kafka
go get github.com/oddbit-project/blueprint/provider/pgsql
All existing imports continue to work without changes due to Go module rewrite rules.
Development & Releases¶
- Release Process - How to create releases and manage independent provider versioning
Configuration¶
Database¶
- Database Package Overview
- Structs and Tags
- Client Interface
- Repository Pattern
- Data Grid System
- Field Specifications
- Query Builder
- Database Functions
- Migration System
- SQL Update API
Security¶
Providers¶
Message Queues & Communication¶
Databases & Storage¶
Web & HTTP¶
- Metrics (documentation pending)
Authentication & Security¶
Utilities¶
Logging¶
HTTP Server¶
- HTTP Server Framework - Complete overview and quick start
- API Reference - Complete server API documentation
- Middleware Components - All middleware and utilities
- Integration Examples - REST API, web app, and microservice examples
- Troubleshooting Guide - Debugging and common issues
- Performance Guide - Optimization and production deployment
- Authentication - Token and JWT authentication providers
- Security & Headers - Security middleware and CSRF protection
- Session Management - Cookie-based session system
- Request Utilities - Request helper functions