Skip to content

Systems

A file in systems/ overrides one inherited System, its Settings, extra Nouns or Integrations, and an untouched System has no file.

A file in systems/ overrides one inherited System: its Settings, extra Nouns, or the Integrations bound to it. An untouched System has no file; the business view is Systems.

  • systems/
  • billing.mdxdunning and invoice Settings
  • scheduling.mdxa calendar Integration

Reference

The file name is the System id. Frontmatter only. The group, such as finance, is a field of the System and never a folder, so regrouping moves no file.

KeyTypeHolds
settingsmapThe System's Settings this Startup changes
nounsNoun namesNouns the System adds for this Startup
integrationsmapOutside accounts bound to the System, with scope

Examples

Minimal

systems/billing.mdx
---
settings: { retryDays: [3, 5, 7] }
---

Leaseline

systems/billing.mdx:

systems/billing.mdx
---
settings:
  retryDays: [3, 5, 7]
  invoiceMemo: Thank you for using Leaseline.
  currency: USD
---

What it builds

The StartupBuilder compiles the file into the System's instance for this Startup.

  • the System's Settings, overriding the Startup Template's
  • an Integration per entry, connected with Integration.connect and reported by Integration.connected
  • in the finance group, Stripe objects under the Startup's own connected account

Good to know

  • Each System's page lists its Settings, Nouns and Verbs; payments start at the finance group.