Brekz Documentation¶
Welcome to the Brekz Documentation Repository. This repository provides centralised documentation for all Brekz services and applications. It is intended as the single source of truth for developers, engineers, and stakeholders.
Purpose¶
- To document the architecture, APIs, workflows, and integrations of all Brekz platforms.
- To provide consistent guidelines and best practices across all services.
- To help onboard new developers quickly and efficiently.
The Brekz platform is a modular, service-oriented ecosystem designed to manage our e-commerce operations, customer interactions, inventory, and marketing automation. Our architecture promotes scalability, flexibility, and maintainability by decoupling responsibilities across independent services.
Platform Services¶
The Brekz platform consists of multiple independently deployed services. Each service has its own documentation covering setup, architecture, and integrations. See the Services section for full details.
| Service | Description |
|---|---|
| brekz-cms | Content Management System for articles, banners, and marketing pages. |
| brekz-prestashop | Core e-commerce engine and product catalog (since 2012). |
| brekz-website | Frontend storefront built with modern web technologies (since 2025). |
| brekz-copernica | Marketing automation and customer journeys. |
| brekz-exact | Synchronises financial data with Exact Online. |
| brekz-logistics | Logistics operations after orders have been placed. |
| Cloudflare | DNS, CDN, caching, and access security. |
| brekz-ergonode | Product Information Management (PIM). Will be replaced by Prestashop. |
| brekz-shop-backend | Backend services supporting order processing. |
| brekz-mobile-payment | Backend services supporting the Brekz payment mobile apps. |
| brekz-app | Native mobile applications for iOS and Android. |
System Architecture¶
graph TD
User --> brekz-prestashop
User --> brekz-website
brekz-prestashop --> brekz-cms
brekz-website --> brekz-prestashop
brekz-prestashop --> brekz-exact-api
brekz-prestashop --> brekz-copernica
brekz-prestashop --> brekz-ergonode
brekz-prestashop --> brekz-shop-backend
brekz-prestashop --> brekz-logistics
brekz-prestashop --> brekz-mobile-payment
User --> brekz-app
brekz-app --> brekz-mobile-payment
brekz-app --> brekz-prestashop
Platform Features¶
Cross-service features and business processes are documented in the Features section.
| Feature | Description |
|---|---|
| Checkout Process | End-to-end checkout flow, covering the current and new templated checkout. |
| Payment Process | Payment flow from customer interaction through to settlement. |
| Order Management | Full lifecycle of a customer order, from creation to fulfilment. |
| Product Management | Lifecycle of products on the platform. |
| A/B Testing | A/B test comparing brekz-website against brekz-prestashop. |
External Tools & Services¶
See the Tools section for full documentation per tool.
| Tool | Category |
|---|---|
| Algolia | Search |
| Cloudflare | DNS, CDN & Security |
| AWS S3 | Storage |
| Copernica | Email Marketing |
| Docdata CS Payments | Payments |
| Exact Globe | ERP & Finance |
| Front | Customer Service |
| GA4 | Analytics |
| GitHub | Source Control & CI/CD |
| Google Tag Manager | Tag Management |
| Infisical | Secrets Management |
| Microsoft Fabric | Analytics & Business Intelligence |