CLI to install project (twentyhq#164)

* CLI to install project * CLI fixes * Update README.md * Cleanup gitignore
sdileep · Jun 1, 2023 · e8f1146 · e8f1146
1 parent 7d87598
commit e8f1146
Show file tree

Hide file tree

Showing 22 changed files with 6,639 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,9 @@ It is meant to be:
 - Perfectly in-sync with your data
 - Crafted with care and enjoyable to use
 
+# Quickstart
+No need to clone the repo, just run `npx twenty-cli` in your terminal and follow the instructions.
+
 # Progress
 We are currently in the development phase of Twenty's alpha version:
 

diff --git a/cli/.eslintrc.cjs b/cli/.eslintrc.cjs
@@ -0,0 +1,26 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+      project: 'tsconfig.json',
+      tsconfigRootDir: __dirname,
+      sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint/eslint-plugin'],
+    extends: [
+      'plugin:@typescript-eslint/recommended',
+      'plugin:prettier/recommended'
+    ],
+    root: true,
+    env: {
+      node: true,
+      jest: true,
+    },
+    ignorePatterns: ['.eslintrc.js', 'codegen.js', '**/generated/*', '/lib/*'],
+    rules: {
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  };
+
diff --git a/cli/.gitignore b/cli/.gitignore
@@ -0,0 +1,36 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# Dependency directories
+node_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# other
+lib/
+.DS_Store
diff --git a/cli/.prettierrc b/cli/.prettierrc
@@ -0,0 +1,4 @@
+{
+    "singleQuote": true,
+    "trailingComma": "all"
+}
diff --git a/cli/README.md b/cli/README.md
@@ -0,0 +1,2 @@
+# Twenty CLI
+A simple CLI to get started with Twenty 
diff --git a/cli/__tests__/config.ts b/cli/__tests__/config.ts
@@ -0,0 +1,8 @@
+import { execShell } from '../src/config';
+
+export {};
+
+test('execShell runs a shell command', async () => {
+  let response = await execShell('echo "hello"');
+  expect(response).toEqual('hello\n');
+});
diff --git a/cli/jest.config.cjs b/cli/jest.config.cjs
@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Twenty CLI
		A simple CLI to get started with Twenty