martmull
16e3e38b79
- improves `packages/twenty-docs/developers/extend/apps/getting-started.mdx` --------- Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
This is a [Twenty](https://twenty.com) application project bootstrapped with [`create-twenty-app`](https://www.npmjs.com/package/create-twenty-app).
|
|
|
|
## Getting Started
|
|
|
|
First, authenticate to your workspace:
|
|
|
|
```bash
|
|
yarn twenty remote add --api-url http://localhost:2020 --as local
|
|
```
|
|
|
|
Then, start development mode to sync your app and watch for changes:
|
|
|
|
```bash
|
|
yarn twenty dev
|
|
```
|
|
|
|
Open your Twenty instance and go to `/settings/applications` section to see the result.
|
|
|
|
## Available Commands
|
|
|
|
Run `yarn twenty help` to list all available commands. Common commands:
|
|
|
|
```bash
|
|
# Remotes & Authentication
|
|
yarn twenty remote add --api-url http://localhost:2020 --as local # Authenticate with Twenty
|
|
yarn twenty remote status # Check auth status
|
|
yarn twenty remote switch # Switch default remote
|
|
yarn twenty remote list # List all configured remotes
|
|
yarn twenty remote remove <name> # Remove a remote
|
|
|
|
# Application
|
|
yarn twenty dev # Start dev mode (watch, build, sync, and auto-generate typed client)
|
|
yarn twenty add # Add a new entity (object, field, function, front-component, role, view, navigation-menu-item)
|
|
yarn twenty logs # Stream function logs
|
|
yarn twenty exec # Execute a function with JSON payload
|
|
yarn twenty uninstall # Uninstall app from workspace
|
|
```
|
|
|
|
## Integration Tests
|
|
|
|
If your project includes the example integration test (`src/__tests__/app-install.integration-test.ts`), you can run it with:
|
|
|
|
```bash
|
|
# Make sure a Twenty server is running at http://localhost:3000
|
|
yarn test
|
|
```
|
|
|
|
The test builds and installs the app, then verifies it appears in the applications list. Test configuration (API URL and API key) is defined in `vitest.config.ts`.
|
|
|
|
## LLMs instructions
|
|
|
|
Main docs and pitfalls are available in LLMS.md file.
|
|
|
|
## Learn More
|
|
|
|
To learn more about Twenty applications, take a look at the following resources:
|
|
|
|
- [twenty-sdk](https://www.npmjs.com/package/twenty-sdk) - learn about `twenty-sdk` tool.
|
|
- [Twenty doc](https://docs.twenty.com/) - Twenty's documentation.
|
|
- Join our [Discord](https://discord.gg/cx5n4Jzs57)
|
|
|
|
You can check out [the Twenty GitHub repository](https://github.com/twentyhq/twenty) - your feedback and contributions are welcome!
|