Files

T

martmull 0786f9e793 Seed CHANGELOG.md and SETUP.md in create-twenty-app scaffold (#22769 )

Projects scaffolded with `create-twenty-app` now include two additional
seed files:

- `CHANGELOG.md` with an initial `0.1.0` entry matching the template's
package version
- `SETUP.md` with step-by-step local setup instructions (prerequisites,
install, local server, dev sync, verification commands)

Both files live in `src/constants/template/`, so they flow through the
existing `fs.copy` scaffolding and the vite `copy-assets` build step
with no code changes. Verified `dist/constants/template/` contains both
files after `nx build create-twenty-app`.

The scaffolded `README.md` was also simplified into a marketable front
page for the app being built: a pitch placeholder, a features section,
and links to `SETUP.md` for setup instructions and `CHANGELOG.md` for
history, instead of duplicating dev commands.

Also:

- Adds a regression test asserting the template directory contains both
seed files
- Updates `project-structure.mdx` docs to list the new files in the
scaffold directory tree

---------

Co-authored-by: Martin <martin@twenty.com>

2026-07-10 10:02:43 +02:00

src

Seed CHANGELOG.md and SETUP.md in create-twenty-app scaffold (#22769 )

2026-07-10 10:02:43 +02:00

.oxlintrc.json

Optimize merge queue to only run E2E and integrate prettier into lint (#18459 )

2026-03-06 13:20:57 +01:00

.prettierignore

Optimize merge queue to only run E2E and integrate prettier into lint (#18459 )

2026-03-06 13:20:57 +01:00

jest.config.mjs

chore(create-twenty-app): align scaffold with unified app test/lint/typecheck configs (#22128 )

2026-06-25 10:23:51 +02:00

package.json

chore: bump version to 2.20.0 (#22639 )

2026-07-07 17:40:56 +02:00

project.json

Create twenty app e2e test ci (#18497 )

2026-03-11 16:30:28 +01:00

README.md

fix(cli): detect expired token on deploy and offer interactive re-auth (#21335 )

2026-06-16 14:14:17 +00:00

tsconfig.json

chore(create-twenty-app): align scaffold with unified app test/lint/typecheck configs (#22128 )

2026-06-25 10:23:51 +02:00

tsconfig.lib.json

chore(create-twenty-app): align scaffold with unified app test/lint/typecheck configs (#22128 )

2026-06-25 10:23:51 +02:00

vite.config.ts

fix: Vite 8/Rolldown build warnings in library packages (#22205 )

2026-06-29 12:59:36 +02:00

README.md

Create Twenty App

The official scaffolding CLI for building apps on top of Twenty CRM. Sets up a ready-to-run project with twenty-sdk.

Quick start

npx create-twenty-app@latest my-twenty-app
cd my-twenty-app
yarn twenty dev

The scaffolder will:

Create a new project with TypeScript, linting, tests, and a preconfigured twenty CLI
Start a local Twenty server via Docker (pulls the latest image automatically)
Authenticate with the development API key

Options

Flag	Description
`--name <name>`	Set the app name
`--display-name <displayName>`	Set the display name
`--description <description>`	Set the description
`--url <url>`	Twenty workspace URL (default: `http://localhost:2020`)
`--authentication-method <method>`	`oauth` or `apiKey` (default: `apiKey` for local, `oauth` for remote)

Documentation

Full documentation is available at docs.twenty.com/developers/extend/apps:

Quick Start — scaffold, run a local server, sync your code
Concepts — how apps work: entity model, sandboxing, lifecycle
Operations — CLI, testing, CI, deploy and publish

Troubleshooting

Server not starting: check Docker is running (docker info), then try yarn twenty docker:logs.
Auth not working: run yarn twenty remote:add to re-authenticate.
Types not generated: ensure yarn twenty dev is running — it auto-generates the typed client.

Contributing

See our GitHub
Join our Discord