77[![MIT License][license-shield]][license-url]
88[](docs/coverage/index.html)
99
10- [](https://github.com/{{GITHUB_USERNAME}}/{{PROJECT_NAME}}/actions/workflows/ci.yml)
11- [](https://github.com/{{GITHUB_USERNAME}}/{{PROJECT_NAME}}/actions/workflows/codeql.yml)
12- [](https://www.python.org/downloads/)
13- [](https://github.com/astral-sh/ruff)
14- [](https://docs.astral.sh/ruff/rules/#flake8-bandit-s)
10+ [](https://github.com/{{GITHUB_USERNAME}}/{{PROJECT_NAME}}/actions/workflows/ci.yml)
11+ [](https://www.python.org/downloads/)
1512
1613> {{PROJECT_DESCRIPTION}}
1714
@@ -104,44 +101,18 @@ task mut-report # Mutation testing (optional)
104101
105102## 🐳 Docker Usage
106103
107- Modern Docker setup with multi-stage builds, distroless production images, and comprehensive development workflows.
108-
109- ### Development Environment
110-
111- ```bash
112- # Start development environment with hot reload
113- docker-compose up
114-
115- # Run specific services
116- docker-compose up app # Main application
117- docker-compose up docs # Documentation server (localhost:8080)
118-
119- # Development with profiles
120- docker-compose --profile test up # Run test suite
121- docker-compose --profile quality up # Code quality checks
122- ```
123-
124- ### Production Deployment
104+ Simple Docker setup for development with hot reload and integrated tooling.
125105
126106```bash
127- # Build production image (distroless, security-optimized)
128- docker build --target production -t {{PROJECT_NAME}}:prod .
129-
130- # Production testing environment
131- docker-compose -f docker-compose.prod.yml up
132-
133- # Security scanning
134- docker-compose -f docker-compose.prod.yml --profile security up
135-
136- # Load testing
137- docker-compose -f docker-compose.prod.yml --profile load-test up
107+ # Development workflows
108+ docker-compose up # Hot reload development environment
109+ docker-compose --profile test up # Run complete test suite
110+ docker-compose --profile docs up # Documentation server (localhost:8080)
111+ docker-compose --profile quality up # Code quality checks (lint + typecheck)
112+
113+ # Build standalone image
114+ docker build -t {{PROJECT_NAME}} . # Build development image
138115```
139-
140- ### Key Features
141-
142- - **🔒 Security-First**: Distroless production images, non-root user, vulnerability scanning
143- - **⚡ Performance**: BuildKit caching, uv package manager, optimized layer ordering
144- - **📊 Monitoring**: Health checks, resource limits, comprehensive logging
145116- **🛠️ Development**: Hot reload, separate services for testing/docs/quality checks
146117
147118
@@ -155,7 +126,7 @@ docker-compose -f docker-compose.prod.yml --profile load-test up
155126| **Testing** | PyTest + Hypothesis (property-based testing), pytest-html-plus (BDD reports) |
156127| **AI Integration** | OpenCode agents for development automation |
157128| **Documentation** | pdoc with search functionality |
158- | **Containerization** | Docker with distroless production, BuildKit caching, security scanning |
129+ | **Containerization** | Docker development environment with hot reload |
159130
160131## 📈 Quality Metrics
161132
@@ -168,22 +139,18 @@ docker-compose -f docker-compose.prod.yml --profile load-test up
168139## 🚀 Deployment Ready
169140
170141```bash
171- # Production container (distroless, security-hardened)
172- docker build --target production - t {{PROJECT_NAME}}:latest .
173- docker run {{PROJECT_NAME}}:latest
142+ # Build container image
143+ docker build -t {{PROJECT_NAME}} .
144+ docker run {{PROJECT_NAME}}
174145
175- # Production environment testing
176- docker-compose -f docker-compose.prod.yml up
146+ # Run with Docker Compose
147+ docker-compose up
177148
178149# Build API documentation
179150task doc-build # Generates docs/api/index.html
180151
181- # Publish API docs to GitHub Pages
182- task doc-publish # Pushes docs/api to gh-pages branch
183-
184- # Smart release management
185- @repo-manager /skill git-release
186- # Creates versioned release: v1.2.20260315 "Creative Fox"
152+ # Serve documentation locally
153+ task doc-serve # http://localhost:8080
187154```
188155
189156## 🤝 Contributing
0 commit comments