The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
---
title: Структура проекта
description: Что находится внутри сгенерированного приложения Twenty — файлы, папки и назначение каждого из них.
---
import { PageBanner } from "/snippets/page-banner.mdx"
## Обзор
Новое приложение, сгенерированное с помощью `twenty app init`, выглядит так:
```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
logic-functions/
health-check.ts # Reports whether the app can run
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
publish.yml # Publish to npm on version tags (with provenance)
public/
logo.svg # Static assets
locales/
en.json # Source catalog; add <locale>.json files next to it
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
```
## Ключевые файлы
| Файл / Папка | Назначение |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `src/application-config.ts` | **Обязательно.** Основной файл конфигурации для вашего приложения. |
| `src/default-role.ts` | Роль по умолчанию, контролирующая, к чему имеют доступ ваши логические функции. |
| `src/constants/universal-identifiers.ts` | Автоматически генерируемые UUID и метаданные (отображаемое имя, описание). |
| `src/front-components/`, `src/navigation-menu-items/`, `src/page-layouts/` | Стартовая приветственная страница: фронтенд-компонент, отображаемый отдельным макетом страницы и доступный из боковой панели. |
| `src/logic-functions/health-check.ts` | Начальная [проверка работоспособности](/ru/developers/extend/apps/logic/logic-functions#health-check), сообщающая `ok`. Заполните её, чтобы выявить проблемы с конфигурацией, которые может обнаружить только ваше приложение. |
| `src/__tests__/` | Модульный тест плюс интеграционный тест (с его глобальной настройкой), которые синхронизируют приложение с реальным сервером. |
| `public/` | Статические ресурсы (изображения, шрифты), обслуживаемые вместе с вашим приложением. |
| `locales/` | Каталоги переводов. `en.json` — это исходный каталог, который заполняет `twenty app translations extract`; набор файлов здесь — это то, что публикует синхронизация, поэтому пустая папка означает отсутствие переводов. `locales/compiled/` записывается командой `twenty app pull` для записей, исходные строки которых ещё отсутствуют в дереве, также публикуется синхронизацией и не предназначен для ручного редактирования. |
| `AGENTS.md` / `CLAUDE.md` | Руководство для ИИ-агентов, пишущих код для приложения. |
| `CHANGELOG.md` / `SETUP.md` | Журнал значимых изменений и инструкции по настройке для локальной разработки. |
<Note>
**Организация файлов — на ваше усмотрение.** Приведенные выше папки являются соглашениями — CLI обнаруживает сущности с помощью AST-анализа вызовов `export default defineEntity(...)` независимо от того, где расположен файл.
</Note>
## Зависимости
Пакеты Twenty SDK и UI должны находиться в `devDependencies`:
```json filename="package.json"
{
"dependencies": {},
"devDependencies": {
"twenty-client-sdk": "2.40.0",
"twenty-sdk": "2.40.0",
"twenty-ui": "2.40.0"
}
}
```
`twenty app init` привязывает `twenty-sdk`, `twenty-client-sdk` и `twenty-ui` к собственной версии. При обновлении синхронизируйте все три.
* **`twenty-sdk`** предоставляет определения приложений, вспомогательные средства среды выполнения и интеграцию с рендерером. Используйте отдельно установленный пакет **`twenty`** для команд CLI и инструментов сборки/создания шаблонов.
* **`twenty-client-sdk`** *действительно* импортируется кодом вашего приложения (`CoreApiClient`, `MetadataApiClient`, `RestApiClient`), но Twenty предоставляет его во время выполнения — функции логики получают его из сгенерированного слоя SDK, а фронтенд‑компоненты получают его из модулей, отдаваемых сервером. Установленная вами копия используется только для проверки типов и сборки на этапе деплоя, поэтому её не нужно включать в развертываемый бандл.
Если любой из пакетов находится в `dependencies`, он попадает в бандл среды выполнения установленного приложения, где он является лишним грузом. `twenty app build` выдаёт предупреждение, если любой из них всё ещё указан в `dependencies`.
Добавляйте собственные зависимости среды выполнения вашего приложения (библиотеки, которые ваши функции логики действительно импортируют во время выполнения) в `dependencies`, как обычно. Держите дерево лёгким: `dependencies` устанавливаются в слой выполнения с ограничением 250 МБ в распакованном виде, и операция синхронизации или установки завершается ошибкой размера зависимостей при превышении этого лимита — UI-библиотеки и инструменты разработки должны находиться в `devDependencies`.
<PageBanner illustration="card-page-frontend-architecture" />