martmull
0786f9e793
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>
79 lines
4.0 KiB
Plaintext
79 lines
4.0 KiB
Plaintext
---
|
|
title: Project Structure
|
|
description: What's inside a scaffolded Twenty app — files, folders, and what each one does.
|
|
icon: "folder-tree"
|
|
---
|
|
|
|
A new app generated by `npx create-twenty-app` looks like this:
|
|
|
|
```text filename="my-twenty-app/"
|
|
my-twenty-app/
|
|
package.json
|
|
src/
|
|
application-config.ts # Required — your app's entry point
|
|
default-role.ts # Permissions for logic functions
|
|
constants/
|
|
universal-identifiers.ts # Auto-generated UUIDs and metadata
|
|
front-components/
|
|
main-page.tsx # Welcome page component
|
|
navigation-menu-items/
|
|
main-page.navigation-menu-item.ts # Sidebar entry for the welcome page
|
|
page-layouts/
|
|
main-page.page-layout.ts # Standalone page hosting the component
|
|
__tests__/
|
|
application-config.test.ts # Unit test
|
|
global-setup.ts # Integration test setup (sync + uninstall)
|
|
schema.integration-test.ts # Integration test against a live server
|
|
.github/workflows/
|
|
ci.yml # Lint, typecheck, unit + integration tests
|
|
cd.yml # Deploy + install on push to main
|
|
public/
|
|
logo.svg # Static assets
|
|
vitest.config.ts # Integration test runner config
|
|
vitest.unit.config.ts # Unit test runner config
|
|
tsconfig.json, tsconfig.spec.json
|
|
.nvmrc, .yarnrc.yml, .oxlintrc.json
|
|
README.md, AGENTS.md, CLAUDE.md, CHANGELOG.md, SETUP.md
|
|
```
|
|
|
|
## Key files
|
|
|
|
| File / Folder | Purpose |
|
|
|---|---|
|
|
| `src/application-config.ts` | **Required.** The main configuration file for your app. |
|
|
| `src/default-role.ts` | Default role controlling what your logic functions can access. |
|
|
| `src/constants/universal-identifiers.ts` | Auto-generated UUIDs and metadata (display name, description). |
|
|
| `src/front-components/`, `src/navigation-menu-items/`, `src/page-layouts/` | A starter welcome page: a front component rendered by a standalone page layout, reachable from the sidebar. |
|
|
| `src/__tests__/` | A unit test plus an integration test (with its global setup) that syncs the app against a real server. |
|
|
| `public/` | Static assets (images, fonts) served with your app. |
|
|
| `AGENTS.md` / `CLAUDE.md` | Guidance for AI coding agents working on the app. |
|
|
| `CHANGELOG.md` / `SETUP.md` | Changelog of notable changes and setup instructions for local development. |
|
|
|
|
<Note>
|
|
**File organization is up to you.** The folders above are conventions — the SDK detects entities via AST analysis on `export default defineEntity(...)` calls regardless of where the file lives.
|
|
</Note>
|
|
|
|
## Dependencies
|
|
|
|
Both Twenty SDK packages belong under `devDependencies`, not `dependencies`:
|
|
|
|
```json filename="package.json"
|
|
{
|
|
"dependencies": {},
|
|
"devDependencies": {
|
|
"twenty-client-sdk": "2.20.0",
|
|
"twenty-sdk": "2.20.0",
|
|
"twenty-ui": "1.0.0-alpha.1"
|
|
}
|
|
}
|
|
```
|
|
|
|
The scaffolder pins `twenty-sdk` and `twenty-client-sdk` to its own version — keep the two in sync when upgrading.
|
|
|
|
- **`twenty-sdk`** ships the `twenty` CLI and the build/scaffolding tooling. It only runs at development and build time and is never imported by your published app's runtime.
|
|
- **`twenty-client-sdk`** _is_ imported by your app code (`CoreApiClient`, `MetadataApiClient`, `RestApiClient`), but Twenty provides it at runtime — logic functions get it from a generated SDK layer, and front components resolve it from server-served modules. Your installed copy is only used for typechecking and the deploy-time build, so it never needs to ship in the deployed bundle.
|
|
|
|
Keeping either package under `dependencies` pulls it into the installed app's runtime bundle, where it is dead weight. `twenty dev:build` emits a warning when either is still listed under `dependencies`.
|
|
|
|
Add your app's own runtime dependencies (libraries your logic functions actually import at runtime) under `dependencies` as usual.
|