create-tanstack-app 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,93 @@
+# Create TanStack App
+
+This CLI tool helps you quickly set up a new TanStack app by downloading and initializing the template from [GitHub](https://github.com/SH20RAJ/tanstack-start). It's perfect for building full-stack applications using TanStack's powerful router and full-stack capabilities.
+
+## Features:
+- Full-Document SSR
+- Streaming
+- Server Functions (RPCs)
+- Automatic type-safe routing with TanStack Router
+- Deployment-ready app setup
+
+## Getting Started
+
+### Install
+
+You can use the CLI to set up a new TanStack app directly from GitHub with:
+
+```bash
+npx create-tanstack-app@latest
+```
+
+This will:
+1. Download the starter template from [https://github.com/SH20RAJ/tanstack-start](https://github.com/SH20RAJ/tanstack-start)
+2. Initialize the project with all necessary dependencies and configurations.
+
+### Dependencies
+
+Your new project will include:
+- **TanStack Router**: A powerful type-safe routing system for React.
+- **Vinxi**: A bundler and deployment tool.
+- **Vite**: For fast build and development.
+- **React**: Frontend library to build the app.
+- **TypeScript**: For type safety throughout the app.
+
+### Project Structure
+
+Once the setup is complete, your project will have a structure similar to this:
+
+```
+my-app/
+├── app/
+│   ├── routes/
+│   │   └── __root.tsx
+│   ├── client.tsx
+│   ├── router.tsx
+│   ├── routeTree.gen.ts
+│   └── ssr.tsx
+├── .gitignore
+├── app.config.ts
+├── package.json
+└── tsconfig.json
+```
+
+### Running the App
+
+Once the setup is complete, run the following command to start the app:
+
+```bash
+npm run dev
+```
+
+This will start the development server, and you can start building your app with TanStack's full-stack routing and SSR features.
+
+For more details on how to configure your app, refer to the official [TanStack Start Docs](https://tanstack.com/start/latest).
+
+---
+
+Make sure that your `index.js` for this npm package initializes the necessary steps to clone the repo from GitHub and set it up locally. You can use Node's `child_process` module to clone the repository and run the initial npm setup commands for users. For example:
+
+```js
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const repoUrl = 'https://github.com/SH20RAJ/tanstack-start.git';
+const targetDir = path.join(process.cwd(), 'tanstack-app');
+
+try {
+  if (!fs.existsSync(targetDir)) {
+    console.log('Cloning TanStack app template...');
+    execSync(`git clone ${repoUrl} ${targetDir}`, { stdio: 'inherit' });
+
+    console.log('Installing dependencies...');
+    execSync('npm install', { cwd: targetDir, stdio: 'inherit' });
+
+    console.log('Setup complete! You can now run "npm run dev" in the project directory.');
+  } else {
+    console.log('Directory already exists.');
+  }
+} catch (error) {
+  console.error('Error setting up TanStack app:', error);
+}
+```

package/create.js

@@ -0,0 +1,29 @@
+const degit = require('degit');
+const path = require('path');
+const fs = require('fs');
+
+async function initApp() {
+  const projectName = process.argv[2] || 'my-tanstack-app'; // default to 'my-tanstack-app' if no name is provided
+  const dest = path.join(process.cwd(), projectName);
+
+  // Check if the destination already exists
+  if (fs.existsSync(dest)) {
+    console.log('Directory already exists. Please choose another name or delete the existing directory.');
+    return;
+  }
+
+  console.log(`Downloading Tanstack app template from GitHub...`);
+  
+  // Use degit to download the template
+  const emitter = degit('SH20RAJ/tanstack-start', { cache: false, force: true });
+  emitter.on('info', info => console.log(info));
+
+  try {
+    await emitter.clone(dest);
+    console.log(`Template successfully downloaded! Navigate to ${dest} and start working on your project.`);
+  } catch (error) {
+    console.error('Error during template download:', error);
+  }
+}
+
+initApp();

package/index.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+const { exec } = require('child_process');
+const path = require('path');
+
+// Require the create.js script to handle the initialization
+require('./create');
+
+// If you want to call the script from `create.js` directly, you can also define it here.
+// If needed, you could also provide further customization options for users or more handling.

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "create-tanstack-app",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "create": "node create.js"
   },
   "author": "",
   "license": "ISC",
-  "description": ""
+  "description": "A CLI tool to create a Tanstack app",
+  "dependencies": {
+    "degit": "^2.8.4"
+  }
 }