create-twenty-app 2.4.0 → 2.4.2

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.
Files changed (9) hide show
  1. package/README.md +11 -10
  2. package/dist/cli.cjs +41 -56
  3. package/dist/cli.mjs +3826 -3886
  4. package/dist/constants/template/README.md +11 -0
  5. package/dist/constants/template/github/workflows/cd.yml +1 -1
  6. package/dist/create-app.command.d.ts +13 -8
  7. package/dist/utils/docker-install.d.ts +2 -0
  8. package/package.json +2 -4
  9. package/src/constants/template/README.md +11 -0
package/dist/constants/template/README.md CHANGED
@@ -2,8 +2,19 @@ This is a [Twenty](https://twenty.com) application bootstrapped with [`create-tw
2
2
 
3
3
  ## Getting Started
4
4
 
5
+ This app was scaffolded with a local Twenty server running at [http://localhost:2020](http://localhost:2020).
6
+
7
+ Login with the default development credentials: `tim@apple.dev` / `tim@apple.dev`.
8
+
5
9
  Run `yarn twenty help` to list all available commands.
6
10
 
11
+ ## Useful Commands
12
+
13
+ - `yarn twenty dev` - Start the development server and sync your app
14
+ - `yarn twenty server status` - Check the local Twenty server status
15
+ - `yarn twenty server start` - Start the local Twenty server
16
+ - `yarn test` - Run integration tests
17
+
7
18
  ## Learn More
8
19
 
9
20
  - [Twenty Apps documentation](https://docs.twenty.com/developers/extend/apps/getting-started/quick-start)
package/dist/constants/template/github/workflows/cd.yml CHANGED
@@ -11,7 +11,7 @@ permissions:
11
11
  contents: read
12
12
 
13
13
  env:
14
- TWENTY_DEPLOY_URL: http://localhost:3000
14
+ TWENTY_DEPLOY_URL: http://localhost:2020
15
15
 
16
16
  concurrency:
17
17
  group: cd-${{ github.ref }}
package/dist/create-app.command.d.ts CHANGED
@@ -1,24 +1,29 @@
1
+ export type AuthenticationMethod = 'oauth' | 'apiKey';
1
2
  type CreateAppOptions = {
2
3
  directory?: string;
3
4
  example?: string;
4
5
  name?: string;
5
6
  displayName?: string;
6
7
  description?: string;
7
- skipLocalInstance?: boolean;
8
- yes?: boolean;
8
+ apiUrl?: string;
9
+ authenticationMethod?: AuthenticationMethod;
9
10
  };
10
11
  export declare class CreateAppCommand {
11
- private static TOTAL_STEPS;
12
+ private stepCounter;
13
+ private totalSteps;
12
14
  execute(options?: CreateAppOptions): Promise<void>;
15
+ private computeTotalSteps;
13
16
  private getAppInfos;
14
17
  private validateDirectory;
15
18
  private tryDownloadExample;
16
- private promptScaffoldConfirmation;
17
- private logStep;
19
+ private logPlan;
20
+ private logNextStep;
18
21
  private logDetail;
19
- private shouldStartServer;
20
- private logServerSkipped;
21
- private promptConnectToLocal;
22
+ private pullImageInBackground;
23
+ private ensureDockerServer;
24
+ private authenticateWithDevKey;
25
+ private deriveRemoteName;
26
+ private authenticateWithOAuth;
22
27
  private logSuccess;
23
28
  }
24
29
  export {};
package/dist/utils/docker-install.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export declare const isDockerInstalled: () => boolean;
2
+ export declare const getDockerInstallInstructions: () => string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-twenty-app",
3
- "version": "2.4.0",
3
+ "version": "2.4.2",
4
4
  "description": "Command-line interface to create Twenty application",
5
5
  "main": "dist/cli.cjs",
6
6
  "bin": "dist/cli.cjs",
@@ -32,18 +32,16 @@
32
32
  "chalk": "^5.3.0",
33
33
  "commander": "^12.0.0",
34
34
  "fs-extra": "^11.2.0",
35
- "inquirer": "^10.0.0",
36
35
  "lodash.camelcase": "^4.3.0",
37
36
  "lodash.kebabcase": "^4.1.1",
38
37
  "lodash.startcase": "^4.4.0",
39
- "twenty-sdk": "2.4.0",
38
+ "twenty-sdk": "2.4.2",
40
39
  "uuid": "^13.0.0"
41
40
  },
42
41
  "devDependencies": {
43
42
  "@swc/core": "^1.15.11",
44
43
  "@swc/jest": "^0.2.39",
45
44
  "@types/fs-extra": "^11.0.0",
46
- "@types/inquirer": "^9.0.0",
47
45
  "@types/jest": "^30.0.0",
48
46
  "@types/lodash.camelcase": "^4.3.7",
49
47
  "@types/lodash.kebabcase": "^4.1.7",
package/src/constants/template/README.md CHANGED
@@ -2,8 +2,19 @@ This is a [Twenty](https://twenty.com) application bootstrapped with [`create-tw
2
2
 
3
3
  ## Getting Started
4
4
 
5
+ This app was scaffolded with a local Twenty server running at [http://localhost:2020](http://localhost:2020).
6
+
7
+ Login with the default development credentials: `tim@apple.dev` / `tim@apple.dev`.
8
+
5
9
  Run `yarn twenty help` to list all available commands.
6
10
 
11
+ ## Useful Commands
12
+
13
+ - `yarn twenty dev` - Start the development server and sync your app
14
+ - `yarn twenty server status` - Check the local Twenty server status
15
+ - `yarn twenty server start` - Start the local Twenty server
16
+ - `yarn test` - Run integration tests
17
+
7
18
  ## Learn More
8
19
 
9
20
  - [Twenty Apps documentation](https://docs.twenty.com/developers/extend/apps/getting-started/quick-start)