create-twenty-app 2.3.1 → 2.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -10
- package/dist/cli.cjs +41 -56
- package/dist/cli.mjs +3826 -3886
- package/dist/constants/template/README.md +11 -0
- package/dist/constants/template/github/workflows/cd.yml +1 -1
- package/dist/create-app.command.d.ts +13 -8
- package/dist/utils/docker-install.d.ts +2 -0
- package/package.json +2 -4
- package/src/constants/template/README.md +11 -0
package/README.md
CHANGED
|
@@ -25,18 +25,19 @@ yarn twenty dev
|
|
|
25
25
|
The scaffolder will:
|
|
26
26
|
|
|
27
27
|
1. Create a new project with TypeScript, linting, tests, and a preconfigured `twenty` CLI
|
|
28
|
-
2.
|
|
29
|
-
3.
|
|
28
|
+
2. Start a local Twenty server via Docker (pulls the latest image automatically)
|
|
29
|
+
3. Authenticate with the development API key
|
|
30
30
|
|
|
31
31
|
## Options
|
|
32
32
|
|
|
33
|
-
| Flag
|
|
34
|
-
|
|
|
35
|
-
| `--example <name>`
|
|
36
|
-
| `--name <name>`
|
|
37
|
-
| `--display-name <displayName>`
|
|
38
|
-
| `--description <description>`
|
|
39
|
-
| `--
|
|
33
|
+
| Flag | Description |
|
|
34
|
+
| ---------------------------------- | --------------------------------------------------------------------- |
|
|
35
|
+
| `--example <name>` | Initialize from an example |
|
|
36
|
+
| `--name <name>` | Set the app name |
|
|
37
|
+
| `--display-name <displayName>` | Set the display name |
|
|
38
|
+
| `--description <description>` | Set the description |
|
|
39
|
+
| `--api-url <url>` | Twenty instance URL (default: `http://localhost:2020`) |
|
|
40
|
+
| `--authentication-method <method>` | `oauth` or `apiKey` (default: `apiKey` for local, `oauth` for remote) |
|
|
40
41
|
|
|
41
42
|
By default (no flags), a minimal app is generated with core files and an integration test. Use `--example` to start from a richer example:
|
|
42
43
|
|
|
@@ -57,7 +58,7 @@ Full documentation is available at **[docs.twenty.com/developers/extend/apps](ht
|
|
|
57
58
|
## Troubleshooting
|
|
58
59
|
|
|
59
60
|
- Server not starting: check Docker is running (`docker info`), then try `yarn twenty server logs`.
|
|
60
|
-
- Auth not working:
|
|
61
|
+
- Auth not working: run `yarn twenty remote add --local` to re-authenticate.
|
|
61
62
|
- Types not generated: ensure `yarn twenty dev` is running — it auto-generates the typed client.
|
|
62
63
|
|
|
63
64
|
## Contributing
|