Skip to content

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.

Repository Structure

/
│
├── README.md                    → About this documentation repo (purpose, structure, contributors)
│
├── overview.md                  → General architecture overview / high-level service diagram
│
├── services/
│   ├── brekz-cms/
│   │   ├── README.md            → What this service does
│   │   ├── setup.md             → Installation & environment setup
│   │   ├── api.md               → API specifications
│   │   └── changelog.md         → Release information & version history
│   │
│   ├── brekz-prestashop/
│   ├── brekz-shop-backend/
│   ├── brekz-logistics/
│   ├── brekz-website-new/
│   ├── brekz-copernica/
│   ├── brekz-exact-api/
│   ├── brekz-ergonode/
│   ├── brekz-mobile/
│   └── brekz-app/
│
├── features/
│   ├── order-management.md
│   ├── product-information.md
│   └── customer-notifications.md
│
├── shared/
│   ├── guidelines.md            → General coding guidelines & standards
│   ├── logging.md               → Logging & monitoring standards
│   └── security.md              → Security and privacy best practices
│
├── tools/                      → External tools & services documentation
│   ├── algolia/
│   ├── copernica/
│   ├── powerbi/
│   ├── cloudflare/
│   ├── github/
│   ├── docdata-cs-payments/
│   ├── exact-globe/
│   ├── infisical/
│   ├── front/
│   ├── ga4/
│   ├── google-tag-manager/
│   └── aws-s3/
│
└── diagrams/
    ├── architecture.mmd         → Mermaid diagram: system & service relations
    ├── workflows.mmd            → Mermaid diagram: example process flows
Folder Description
/services Contains documentation for individual services (CMS, Website, APIs, etc.).
/features Contains big features of all services created by the platform
/shared Contains general guidelines, logging standards, security policies, etc.
/tools Contains documentation for external tools and services used by Brekz.
/diagrams Contains architecture and workflow diagrams (Mermaid format).

List of Brekz Services

  • brekz-cms
  • brekz-prestashop
  • brekz-website (new)
  • brekz-copernica
  • brekz-exact-api
  • brekz-ergonode
  • brekz-logistics
  • brekz-mobile
  • brekz-app

Each service has its folder under /services/.

System Overview

This diagram represents the high-level interaction between our core services and applications.

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

External Tools & Services

This section documents the external tools and services used by Brekz. Each page provides a short description, what the tool does, and how we use it.

  • Algolia
  • Copernica (Email Marketing)
  • Power BI
  • Cloudflare
  • GitHub
  • Docdata CS Payments
  • Exact Globe
  • Infisical
  • Front (Customer Service)
  • Google Analytics 4 (GA4)
  • Google Tag Manager (GTM)
  • AWS S3