flowCreate.solutions

Home

Software Engineering Standards

Documentation

Overview Project Structure ADRs Runbooks Templates

Backend

Technology Stack Architecture

Overview Data Handling & Secrets Security Automation Authentication Rate Limiting XSS Prevention Reporting

Module Structure Conventions Migrations Generic Example - Models Generic Example - Schemas Generic Example - CRUD Generic Example - APIs Generic Example - Module Walkthrough

Migrations (Operational)

Migrations - Sync Local Schema Migrations - Run Dev Migrations Migrations - Run Prod Migrations

Local Setup SDLC Governance Observability Error Handling Logging

Overview Structure Fixtures Generic Example - Conftest Generic Example - CRUD Tests Generic Example - API Tests Generic Example - Security Tests

AI Engine Notifications Workers

Overview Data Model Ingestion & Indexing Retrieval & Ranking Entity Hybrid Search Operations

Frontend

Technology Stack Architecture

Overview Authentication CSRF Headers & CSP XSS & Content Rendering Data Handling & Secrets Security Automation

Code Organization

Project Structure Naming Conventions Imports & Boundaries

UI & Design System

Tailwind Conventions Components Library Design System Page

Data, State & Forms

BFF API Layer API Client React Query Forms & Validation

Local Setup Railway Deployment Notes Error Handling Logging & Observability

Overview Structure Unit & Component Testing E2E (Playwright)

Error Tracking Analytics & Tracking

Generic Example

BFF Route Handler Proxy API Client RHF + Zod Form React Query Design System Page (Dev-only)

Playbooks

Playbook Creation Guide Project README Template Example Tracker

Workflow (Monorepo + Split Repos)

Playbook Creation Guide Template Example

Documentation

This section defines how we structure, write, and maintain documentation across projects so information stays discoverable, consistent, and easy to keep up to date.

In this section

Overview
Project Structure
ADRs
Runbooks
Templates

On this page

No headings