Back to Twenty

Postcard App — Twenty App Example

packages/twenty-apps/examples/postcard/README.md

2.2.01.8 KB
Original Source

Postcard App — Twenty App Example

A rich example app showcasing all Twenty app entity types. Use this as a reference when building your own apps.

What's included

This app demonstrates every entity type available in the Twenty SDK:

EntityFilesWhat it shows
Applicationsrc/application.config.tsApp metadata, application variables, server variables
Objectssrc/objects/Custom objects with inline fields, junction tables
Fieldssrc/fields/Standalone fields, relations (ONE_TO_MANY, MANY_TO_ONE), extending standard objects
Logic Functionssrc/logic-functions/HTTP routes, database event triggers, cron schedules, tool functions, install hooks
Front Componentssrc/components/React components rendered inside Twenty's UI
Rolessrc/roles/Permission roles with object and field-level access control
Viewssrc/views/Saved table views with column configuration
Navigationsrc/navigation-menu-items/Sidebar links targeting views
Skillssrc/skills/AI skill providing context to agents
Agentssrc/agents/AI agent with a system prompt
Page Layoutssrc/page-layouts/Custom record page with a front component widget

Getting started

bash
# From this directory
yarn install
yarn twenty dev

Or use it as a template via create-twenty-app:

bash
npx create-twenty-app@latest my-app --example postcard

Learn more