Skip to content

index.md

Latest commit

 

History

History
59 lines (45 loc) · 3.96 KB

index.md

File metadata and controls

59 lines (45 loc) · 3.96 KB
Raw

dygo Documentation

dygo is an opinionated Go framework for building metadata-driven business software.

Use this index to find the right document for the task. The docs are kept in the repository so behavior, CLI commands, and file formats can be reviewed with the code that implements them.

Start Here

  • Installation explains release binaries, installer scripts, and project upgrades.
  • CLI is the command reference for project, database, metadata, server, Job, worker, and secret commands.
  • Doctrine explains the framework principles behind dygo's defaults.
  • Nomenclature defines terms used across code, docs, CLI output, metadata, and Studio.

Build Apps

  • App Model explains built-in apps, business apps, and app install locations.
  • App Manifest defines app.yml.
  • Entity Metadata defines Entity YAML, route slugs, Record naming, storage naming, field types, indexes, and constraints.
  • Page Metadata defines app-owned Page YAML, route paths, renderers, and the Page bundle convention.
  • Access records the proposed app role and Entity access authoring model.
  • Workflow records the proposed model for lifecycle actions, status transitions, approvals, and document-style operations.
  • Metadata Authoring explains JSON Schemas and editor support for dygo YAML files.
  • Fixtures explains app-owned seed Records and dygo fixture apply.
  • Record Hooks explains compiled app Record hooks and the entities/<entity>/hooks.go convention.
  • App SDK explains the Go package app code uses for hooks, Jobs, Record access, and Logs.

Run The Platform

  • Config explains dygo.yml, queue config, and current runtime settings.
  • Database explains PostgreSQL config, metadata schema sync, explicit patches, schema prune, schema snapshots, and dygo db check.
  • Explicit Patches explains how unsafe metadata changes are handled without SQL migration files.
  • Server explains dygo dev, dygo serve, the health endpoint, auth, metadata APIs, and Record APIs.
  • Auth explains Administrator bootstrap, session login, and authenticated API identity.
  • Records explains the metadata-powered Record CRUD API.
  • Logs explains persisted framework and app diagnostic events.
  • Encrypted Secrets explains repo-stored encrypted secrets and dygo secret.

Jobs And Automation

  • Jobs explains Job metadata, Job Executions, retries, SDK usage, and Job CLI operations.
  • Queues And Workers explains queue config, worker claiming, notifications, timers, and production worker processes.
  • Schedules explains app-owned recurring Schedules and how workers turn them into Job Executions.

Studio

  • Studio explains the first-party global UI app, route model, and design responsibilities.
  • Dialogs records the proposed shared Studio dialog API.
  • Toasts records the proposed shared Studio toast API.

Maintainers

  • Release Process explains local release checks, tag creation, GitHub release publication, artifacts, and installers.
  • Directory Shape documents the generated project layout, deployed runtime layout, and framework repository layout.
  • Maintainer Notes records repo-maintenance notes that are useful to keep versioned but are not framework reference material.
  • Roadmap tracks local issue status for the dygo repository.
  • Project README gives a short overview and quick start.
  • Contributing explains the current paused contribution status.
  • Security Policy explains private vulnerability reporting and safe research guidelines.
  • Agent Instructions stores repo-level guidance for coding agents.