Skip to content

Developer Documentation

Welcome to the Badger Commerce developer documentation! This directory contains technical guides for building and extending the platform.

Available Guides

Building Extensions

Comprehensive guide for creating custom extensions in Badger Commerce.

Topics covered: - Extension architecture and patterns - Getting started tutorial - Configuration management - Templates and resources - Testing and deployment - Christmas Mode extension walkthrough - Best practices and troubleshooting

Who should read this: - Java developers building custom extensions - Platform engineers extending core functionality - Technical leads architecting extension solutions

Documentation Structure

docs/
├── developers/          ← Technical documentation (you are here)
│   ├── README.md
│   └── building-extensions.md
│
├── features/           ← Feature documentation (marketing/product)
│   └── extension-system.md
│
└── marketing/          ← Marketing materials

Getting Help

  • Browse existing extensions in the codebase
  • Check JavaDoc for API reference
  • Report issues on GitHub
  • Consult the Christmas Mode extension as a reference implementation

Contributing

When contributing extensions: 1. Follow the V2 extension pattern 2. Support all themes (minimum: bootstrap, nova) 3. Write comprehensive tests 4. Document configuration fields 5. Include copyright headers 6. Format code with Spotless

Happy coding! 🚀