Developer Guide 
¶
Welcome to the Steam Stats developer documentation! This section is for contributors, maintainers, and anyone interested in understanding how Steam Stats works under the hood.
Quick Start for Developers ¶
- Project Layout - Understand the codebase structure
- Local Development - Set up your development environment
- Contributing - Coding standards and PR workflow
- Testing - Running and writing tests
Contribution Areas ¶
| Area | Skills Needed | Getting Started |
|---|---|---|
| Core Features | Python, Steam API | Check open issues |
| Documentation | Markdown, MkDocs | See documentation issues |
| Testing | Python, Pytest | Review testing guidelines |
| DevOps | Docker, GitHub Actions | Check workflow files in .github/workflows/ |
Understanding the Codebase ¶
Steam Stats is built with:
- Python 3.12+: Core application logic
- Playwright: Rendered HTML to PNG conversion
- Docker: Containerized execution environment
- GitHub Actions: CI/CD and user workflow automation
Additional Resources ¶
- API Reference: Complete code documentation
- User Guide: End-user documentation
- Examples: Real-world usage examples
Ready to contribute? Start with the Project Layout to understand how everything fits together!