e7da97194a
Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
71 lines
4.6 KiB
Markdown
71 lines
4.6 KiB
Markdown
## Base documentation
|
|
|
|
- Getting started:
|
|
- https://docs.twenty.com/developers/extend/apps/getting-started/quick-start.md
|
|
- https://docs.twenty.com/developers/extend/apps/getting-started/concepts.md
|
|
- https://docs.twenty.com/developers/extend/apps/getting-started/project-structure.md
|
|
- https://docs.twenty.com/developers/extend/apps/getting-started/local-server.md
|
|
- https://docs.twenty.com/developers/extend/apps/getting-started/scaffolding.md
|
|
- https://docs.twenty.com/developers/extend/apps/getting-started/troubleshooting.md
|
|
- Config:
|
|
- https://docs.twenty.com/developers/extend/apps/config/overview.md
|
|
- https://docs.twenty.com/developers/extend/apps/config/application.md
|
|
- https://docs.twenty.com/developers/extend/apps/config/roles.md
|
|
- https://docs.twenty.com/developers/extend/apps/config/install-hooks.md
|
|
- https://docs.twenty.com/developers/extend/apps/config/public-assets.md
|
|
- Data:
|
|
- https://docs.twenty.com/developers/extend/apps/data/overview.md
|
|
- https://docs.twenty.com/developers/extend/apps/data/objects.md
|
|
- https://docs.twenty.com/developers/extend/apps/data/extending-objects.md
|
|
- https://docs.twenty.com/developers/extend/apps/data/relations.md
|
|
- Logic:
|
|
- https://docs.twenty.com/developers/extend/apps/logic/overview.md
|
|
- https://docs.twenty.com/developers/extend/apps/logic/logic-functions.md
|
|
- https://docs.twenty.com/developers/extend/apps/logic/skills-and-agents.md
|
|
- https://docs.twenty.com/developers/extend/apps/logic/connections.md
|
|
- Layout:
|
|
- https://docs.twenty.com/developers/extend/apps/layout/overview.md
|
|
- https://docs.twenty.com/developers/extend/apps/layout/views.md
|
|
- https://docs.twenty.com/developers/extend/apps/layout/navigation-menu-items.md
|
|
- https://docs.twenty.com/developers/extend/apps/layout/page-layouts.md
|
|
- https://docs.twenty.com/developers/extend/apps/layout/front-components.md
|
|
- https://docs.twenty.com/developers/extend/apps/layout/command-menu-items.md
|
|
- Operations:
|
|
- https://docs.twenty.com/developers/extend/apps/operations/overview.md
|
|
- https://docs.twenty.com/developers/extend/apps/operations/cli.md
|
|
- https://docs.twenty.com/developers/extend/apps/operations/testing.md
|
|
- https://docs.twenty.com/developers/extend/apps/operations/publishing.md
|
|
- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/examples/postcard
|
|
|
|
## UUID requirement
|
|
|
|
- All generated UUIDs must be valid UUID v4.
|
|
|
|
## Common Pitfalls
|
|
|
|
- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.
|
|
- Creating a front-end component that has a scroll instead of being responsive to its fixed widget height and width, unless it is specifically meant to be used in a canvas tab.
|
|
|
|
## Best practice
|
|
|
|
It's highly recommended to create new app entities using `yarn twenty dev:add`. These are the options:
|
|
|
|
| Entity type | Command | Generated file |
|
|
| -------------------- | ---------------------------------------- | ------------------------------------- |
|
|
| Object | `yarn twenty dev:add object` | `src/objects/<name>.ts` |
|
|
| Field | `yarn twenty dev:add field` | `src/fields/<name>.ts` |
|
|
| Logic function | `yarn twenty dev:add logicFunction` | `src/logic-functions/<name>.ts` |
|
|
| Front component | `yarn twenty dev:add frontComponent` | `src/front-components/<name>.tsx` |
|
|
| Role | `yarn twenty dev:add role` | `src/roles/<name>.ts` |
|
|
| Skill | `yarn twenty dev:add skill` | `src/skills/<name>.ts` |
|
|
| Agent | `yarn twenty dev:add agent` | `src/agents/<name>.ts` |
|
|
| View | `yarn twenty dev:add view` | `src/views/<name>.ts` |
|
|
| Navigation menu item | `yarn twenty dev:add navigationMenuItem` | `src/navigation-menu-items/<name>.ts` |
|
|
| Page layout | `yarn twenty dev:add pageLayout` | `src/page-layouts/<name>.ts` |
|
|
| Page layout tab | `yarn twenty dev:add pageLayoutTab` | `src/page-layout-tabs/<name>.ts` |
|
|
| Command menu item | `yarn twenty dev:add commandMenuItem` | `src/command-menu-items/<name>.ts` |
|
|
| View field | `yarn twenty dev:add viewField` | `src/view-fields/<name>.ts` |
|
|
| Connection provider | `yarn twenty dev:add connectionProvider` | `src/connection-providers/<name>.ts` |
|
|
|
|
This helps automatically generate required IDs etc.
|