Skip to main content
A complete coding convention template for Electron applications with React frontend and TypeScript.

Download Template

Download as ZIP and extract to .trellis/spec/

What’s Included

CategoryFilesCoverage
Frontend11 filesComponents, hooks, state, IPC, CSS
Backend14 filesAPI patterns, database, error handling
Guides8 filesCross-layer thinking, debugging
Shared6 filesTypeScript, git, code quality

Template Structure

spec/
├── frontend/
│   ├── index.md
│   ├── components.md
│   ├── hooks.md
│   ├── state-management.md
│   ├── ipc-electron.md
│   └── ...

├── backend/
│   ├── index.md
│   ├── api-patterns.md
│   ├── database.md
│   ├── error-handling.md
│   └── ...

├── guides/
│   ├── cross-layer-thinking-guide.md
│   ├── bug-root-cause-thinking-guide.md
│   └── ...

├── shared/
│   ├── typescript.md
│   ├── git-conventions.md
│   └── ...

└── README.md

Key Topics

Frontend

  • React component patterns and hooks
  • Electron IPC communication
  • State management with Zustand
  • CSS design system

Backend

  • API module structure
  • SQLite database patterns
  • Error handling and logging
  • macOS permissions

Guides

  • Cross-layer thinking for full-stack changes
  • Bug root cause analysis
  • Database schema migrations

Usage

  1. Download the ZIP file
  2. Extract to your project’s .trellis/spec/ directory
  3. Customize for your specific conventions
  4. Remove sections that don’t apply
  5. Update examples to match your codebase

View on GitHub

Browse the template source code