WINCHHandbook
WINCH Engineering

The WINCH engineering handbook

One place for how we build software at WINCH — the patterns, the rules, and the workflows that hold our backend (Laravel + DDD) and our frontend (Vue / Nuxt) together.

View docs View backend Domain map
Handbooks
2
Backend chapters
30+
Last reviewed
2026-05-25
Built with
Nuxt UI 4

Products

Two handbooks, one engineering culture

The backend and the frontend share the same conventions where they can — pick the handbook for the codebase you're touching.

Backend Handbook

Laravel 12 on a Domain-Driven Design layout — Actions, Contracts, DTOs, the response envelope, the quality bar every change is held to.

Read the backend docs
Coming soon

Frontend Handbook

The Vue / Nuxt apps that consume the backend — business.winch.sa, the tracking dashboard, and the shared Vuetify component library.

Read the frontend docs

Inside the backend handbook

Four sections, in reading order

The backend handbook is organised top-to-bottom for day one and section-by-section for the rest of the time. The frontend handbook follows the same shape as it comes online.

01

Get Started

Install, configure, ship your first PR.

  • Introduction
  • Installation
  • Configuration
  • Your first PR

02

Structure

Every top-level directory of the repo, explained.

  • Directory structure

03

Guide

Patterns, best practices, workflows, and recipes.

  • Key concepts
  • Best practices
  • Workflows
  • Going further

04

Reference

The map of every domain — DDD adherence, legacy footprint, notes.

  • DDD map

Repositories

The codebases the handbook covers

Six repos across backend and frontend, all sharing the same conventions documented here. Browse the source.

backendprimary

The Winch SA web platform for the business sector — the codebase this handbook documents.

Laravelprivate
saas

The SaaS variant of the backend, sharing core patterns.

Laravelprivate
saas-management

Operator control plane for the SaaS deployments.

PHPprivate
business

business.winch.sa — the customer-facing business app.

Vueprivate
ui

Shared Vue 3 + Vuetify component library used across the apps.

Vue + Vuetifyprivate
handbook

You are here. The source for this documentation site.

Nuxt Contentprivate

Spotted something unclear?

Every chapter has an Edit this page link. If a chapter is wrong, fix it.

How to contribute