Widget Layout Backend

Welcome to the Widget Layout Backend project!

Quick Start

• Build: make build
• Run in development: make dev
• Run tests: make test
• Generate identity header for local requests: make generate-identity

Testing

We use a comprehensive testing system with unique ID generation to ensure reliable, conflict-free tests. Key features:

• Focused Test Files: We prefer multiple smaller, focused test files over large monolithic ones for better maintainability and organization
• Unique ID Generator: Prevents test conflicts with collision-free ID generation
• Reserved Constants: Special IDs for non-existent records and mock scenarios
• Thread Safety: Safe for concurrent test execution
• Test Isolation: Each test run uses a unique database

Quick Test Commands

# Run all tests
make test

# Run specific package tests with verbose output
go test ./pkg/server -v

# Run tests multiple times to check for reliability
go test ./pkg/server -count=3

For comprehensive testing documentation, patterns, and best practices, see docs/TESTING.md.

Local API Requests & Identity Header

Most endpoints require a valid x-rh-identity header. See docs/DEVELOPMENT_IDENTITY_HEADER.md for instructions on generating and using this header for local development and testing.

Documentation

All project documentation is organized in the docs/ folder:

• docs/API.md - Complete API documentation with endpoints, examples, and schemas
• docs/TESTING.md - Comprehensive testing guide with patterns and best practices
• docs/CONFIGURATION.md - Widget mapping and base template configuration guide
• docs/DEVELOPMENT_IDENTITY_HEADER.md - Identity header generation for local development
• docs/AI_AGENT_CONTEXT.md - Guidelines for AI-assisted development

More Information

• See docs/API.md for complete API documentation with endpoints, examples, and schemas.
• See the Makefile for available commands.
• See the cmd/dev/user-identity.go script for identity header generation logic.
• See docs/TESTING.md for comprehensive testing documentation.
• See docs/AI_AGENT_CONTEXT.md for guidelines when using AI-assisted development.

---

For more details, refer to the documentation files in the docs/ directory.