@nishant0121/set-it-up 0.0.7 → 0.0.11

package/DESCRIPTION.md

@@ -0,0 +1,64 @@
+# @nishant0121/set-it-up: The Ultimate Project Scaffolding CLI
+
+## Overview
+
+**Set It Up** is a powerful, developer-centric CLI tool engineered to eliminate the repetitive boilerplate work associated with starting new React and React Native projects. It bridges the gap between "Hello World" and a production-ready architecture.
+
+Unlike standard create scripts that give you a bare-bones entry point, `set-it-up` (via its command `forge`) constructs a robust, scalable foundation tailored to your preferences (TypeScript/JavaScript, Styling, Routing, etc.).
+
+## Why Use This?
+
+Starting a modern frontend project often involves 30-60 minutes of configuration:
+- Setting up tailwind.
+- configuring the router.
+- creating folder structures (`pages`, `components`, `context`).
+- installing navigation libraries for mobile.
+- handling safe area contexts.
+
+**Set It Up** does this in seconds.
+
+## Key Capabilities
+
+### 1. Interactive "Forge" Wizard
+The `forge` command launches an intuitive,inquirer-based terminal wizard that asks you exactly what you need. No complex flags to remember—just answer the questions, and the CLI handles the rest.
+
+### 2. React (Web) Excellence
+- **Vite-Powered:** Uses the fastest build tool in the ecosystem.
+- **Tailwind CSS v4:** Automatically configured with the latest version using the Vite plugin.
+- **Shadcn UI Integration:** The only CLI that can set up Shadcn UI and automatically transpile its TypeScript components to JavaScript if you prefer a JS-only project.
+- **Auto-configured Path Aliases:** Pre-sets `@/` aliases in Vite and TS/JS configs for cleaner imports.
+- **Structure:** Automatically creates `src/pages`, `src/components`, and `src/layouts`.
+- **Router Ready:** Installs `react-router-dom` and sets up a default routing configuration with a Layout and Navbar.
+- **State & Theme:** Optional `AppContext` boilerplating for global state and dark-mode ready theme management.
+
+### 3. React Native (Mobile) Mastery
+- **Modular Architecture:** Moves away from the monolithic `App.tsx` pattern. It generates a clean separation of concerns:
+  - `src/pages/` (Screens)
+  - `src/components/` (Reusable UI)
+- **Navigation Pre-baked:** Installs and configures React Navigation (Native Stack).
+- **Auto-configured Path Aliases:** Ready-to-use path resolution for cleaner codebase management.
+- **Safe Area Handling:** Implements `react-native-safe-area-context` with `SafeAreaProvider` wrapping the app and `SafeAreaView` in screens.
+- **Polished Templates:** The generated starter screens (`HomeScreen`, `DetailsScreen`) are not blank white pages. They feature modern design, cards, shadows, and proper typography, giving you a beautiful starting point.
+
+### 4. Smart & Safe
+- **Prerequisite Checking:** Scans your environment for Node.js, Git, and other tools before starting to prevent mid-install failures.
+- **Package Manager Agnostic:** Works seamlessly with `npm`, `yarn`, and `pnpm`.
+- **Lightning Fast Conversion:** Uses `esbuild` for instant TypeScript to JavaScript transpilation when bridging Shadcn UI into JS projects.
+
+## Technology Stack
+
+- **CLI Engine:** Node.js, Commander, Inquirer, Ora (spinners), Chalk (styling), Boxen, Gradient-String.
+- **Automation:** Execa (process execution), FS-Extra (file system), Esbuild (fast transpilation).
+- **Templates:** React (Vite), React Native (CLI), Tailwind CSS v4, React Navigation, React Router DOM.
+
+## Roadmap (Coming Soon)
+- **Next.js Support:** Full App Router scaffolding with advanced features.
+- **Custom GitHub Templates:** Forge projects from your own private or public repositories.
+- **Backend Forging:** Express.js and FastAPI starter templates.
+
+## Get Started
+
+```bash
+npm install -g @nishant0121/set-it-up
+forge
+```

package/README.md

@@ -1,75 +1,75 @@
-# set-it-up
-
-set-it-up is a high-performance CLI tool designed to bootstrap and forge new projects with pre-configured templates, prerequisite checking, and interactive setup.
-
-## Features
-
-- Interactive Wizard: Professional terminal interface to guide you through project configuration.
-- Prerequisite Checks: Automatically verifies necessary tools (Node.js, Git, etc.) are installed before starting.
-- React Support (Vite):
-  - Fast project scaffolding using Vite.
-  - Automated Tailwind CSS v4 setup.
-  - Standardized project structure (src/pages, src/components).
-  - Integrated Layout and Navbar with React Router DOM support.
-  - Optional Shadcn UI initialization and component addition.
-  - Global AppContext setup for state management.
-  - Automatic TypeScript to JavaScript conversion for Shadcn UI if JS is selected.
-- React Native Support:
-  - Rapid initialization with @react-native-community/cli.
-  - Full support for both TypeScript and JavaScript.
-  - Automated React Navigation integration with boilerplate code.
-- Smart Defaults: Supports npm, yarn, and pnpm based on user preference.
-
-## Installation
-
-To use set-it-up globally on your system:
-
-```bash
-npm install -g @nishant0121/set-it-up
-```
-
-Using npx:
-
-```bash
-npx @nishant0121/set-it-up
-```
-
-## Usage
-
-Run the tool in your terminal:
-
-```bash
-forge
-```
-
-Follow the prompts to:
-
-1. Select your project type (React or React Native).
-2. Provide a project name.
-3. Choose your preferred package manager.
-4. Select language (TypeScript or JavaScript).
-5. Configure additional features (Shadcn UI, Router, Context, Navigation).
-
-### Example Workflow
-
-```text
-SET-IT-UP
-
-Hi there! Let's configure your new project.
-
-? What do you want to build today? React
-? Enter your project name: my-web-app
-? Select your preferred package manager: npm
-? Which language do you want to use? TypeScript
-? Would you like to setup Shadcn UI? Yes
-? Would you like to add React Router DOM? Yes
-? Would you like to setup a global AppContext? Yes
-```
-
-## Contributing
-
-Contributions are welcome. Please open an issue or submit a pull request for improvements.
-
-## License
-
-ISC
+# set-it-up
+
+set-it-up is a high-performance CLI tool designed to bootstrap and forge new projects with pre-configured templates, prerequisite checking, and interactive setup.
+
+## Features
+
+- Interactive Wizard: Professional terminal interface to guide you through project configuration.
+- Prerequisite Checks: Automatically verifies necessary tools (Node.js, Git, etc.) are installed before starting.
+- React Support (Vite):
+  - Fast project scaffolding using Vite.
+  - Automated Tailwind CSS v4 setup.
+  - Standardized project structure (src/pages, src/components).
+  - Integrated Layout and Navbar with React Router DOM support.
+  - Optional Shadcn UI initialization and component addition.
+  - Global AppContext setup for state management.
+  - Automatic TypeScript to JavaScript conversion for Shadcn UI if JS is selected.
+- React Native Support:
+  - Rapid initialization with @react-native-community/cli.
+  - Full support for both TypeScript and JavaScript.
+  - Automated React Navigation integration with boilerplate code.
+- Smart Defaults: Supports npm, yarn, and pnpm based on user preference.
+
+## Installation
+
+To use set-it-up globally on your system:
+
+```bash
+npm install -g @nishant0121/set-it-up
+```
+
+Using npx:
+
+```bash
+npx @nishant0121/set-it-up
+```
+
+## Usage
+
+Run the tool in your terminal:
+
+```bash
+forge
+```
+
+Follow the prompts to:
+
+1. Select your project type (React or React Native).
+2. Provide a project name.
+3. Choose your preferred package manager.
+4. Select language (TypeScript or JavaScript).
+5. Configure additional features (Shadcn UI, Router, Context, Navigation).
+
+### Example Workflow
+
+```text
+SET-IT-UP
+
+Hi there! Let's configure your new project.
+
+? What do you want to build today? React
+? Enter your project name: my-web-app
+? Select your preferred package manager: npm
+? Which language do you want to use? TypeScript
+? Would you like to setup Shadcn UI? Yes
+? Would you like to add React Router DOM? Yes
+? Would you like to setup a global AppContext? Yes
+```
+
+## Contributing
+
+Contributions are welcome. Please open an issue or submit a pull request for improvements.
+
+## License
+
+ISC

package/bin/index.js

@@ -1,23 +1,23 @@
 #!/usr/bin/env node
-
-import { program } from 'commander';
-import { mainWizard } from '../src/wizard.js';
-
-program
-  .version('1.0.0')
-  .description('A powerful CLI to forge new projects')
-  .action(async () => {
-    try {
-      await mainWizard();
-    } catch (error) {
-      if (error.name === 'ExitPromptError' || error.message.includes('User force closed the prompt')) {
-        console.log('\n👋 Goodbye!');
-        process.exit(0);
-      } else {
-        console.error(error);
-        process.exit(1);
-      }
-    }
-  });
-
-program.parse(process.argv);
+
+import { program } from 'commander';
+import { mainWizard } from '../src/wizard.js';
+
+program
+  .version('1.0.0')
+  .description('A powerful CLI to forge new projects')
+  .action(async () => {
+    try {
+      await mainWizard();
+    } catch (error) {
+      if (error.name === 'ExitPromptError' || error.message.includes('User force closed the prompt')) {
+        console.log('\n👋 Goodbye!');
+        process.exit(0);
+      } else {
+        console.error(error);
+        process.exit(1);
+      }
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nishant0121/set-it-up",
-  "version": "0.0.7",
+  "version": "0.0.11",
   "description": "A high-performance CLI tool to bootstrap and forge new projects with pre-configured templates, prerequisite checking, and interactive setup.",
   "license": "ISC",
   "author": "Nishant Patil",
@@ -17,6 +17,7 @@
     "chalk": "^5.6.2",
     "command-exists": "^1.2.9",
     "commander": "^14.0.2",
+    "esbuild": "^0.27.2",
     "execa": "^9.6.1",
     "fs-extra": "^11.3.3",
     "gradient-string": "^3.0.0",

package/src/engines/express.js

@@ -0,0 +1,86 @@
+import { execa } from 'execa';
+import ora from 'ora';
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import path from 'path';
+
+import { 
+  getPackageJson, 
+  getTsConfig, 
+  getIndex, 
+  getRouteIndex, 
+  getController 
+} from '../templates/express/main.js';
+
+export async function setupExpress(answers, expressAnswers) {
+  const spinner = ora('Initializing Express project...').start();
+  try {
+    const { projectName, packageManager } = answers;
+    const isTypescript = expressAnswers.language === 'TypeScript';
+    const projectPath = path.join(process.cwd(), projectName);
+
+    // 1. Create Project Directory
+    await fs.ensureDir(projectPath);
+
+    // 2. Create package.json
+    spinner.text = 'Creating package.json...';
+    const packageJsonContent = getPackageJson(projectName, isTypescript);
+    await fs.writeFile(path.join(projectPath, 'package.json'), packageJsonContent);
+
+    // 3. Create tsconfig.json (if TypeScript)
+    if (isTypescript) {
+      spinner.text = 'Creating tsconfig.json...';
+      const tsConfigContent = getTsConfig();
+      await fs.writeFile(path.join(projectPath, 'tsconfig.json'), tsConfigContent);
+    }
+
+    // 4. Create Source Directories and Files
+    spinner.text = 'Generating project structure...';
+    const srcDir = path.join(projectPath, 'src');
+    const routesDir = path.join(srcDir, 'routes');
+    const controllersDir = path.join(srcDir, 'controllers');
+
+    await fs.ensureDir(srcDir);
+    await fs.ensureDir(routesDir);
+    await fs.ensureDir(controllersDir);
+
+    const ext = isTypescript ? 'ts' : 'js';
+
+    // src/index.ts or src/index.js
+    await fs.writeFile(path.join(srcDir, `index.${ext}`), getIndex(isTypescript));
+
+    // src/routes/index.ts or src/routes/index.js
+    await fs.writeFile(path.join(routesDir, `index.${ext}`), getRouteIndex(isTypescript));
+
+    // src/controllers/exampleController.ts or src/controllers/exampleController.js
+    await fs.writeFile(path.join(controllersDir, `exampleController.${ext}`), getController(isTypescript));
+
+    // Create .env file
+    await fs.writeFile(path.join(projectPath, '.env'), 'PORT=3000\n');
+
+    // Create .gitignore
+    const gitignoreContent = `node_modules
+.env
+dist
+.DS_Store
+coverage
+`;
+    await fs.writeFile(path.join(projectPath, '.gitignore'), gitignoreContent);
+
+
+    // 5. Install Dependencies
+    spinner.text = 'Installing dependencies...';
+    const installCmd = packageManager === 'npm' ? 'install' : 'add';
+    await execa(packageManager, [installCmd], { cwd: projectPath });
+
+    spinner.succeed(chalk.green(`Express project ${projectName} created successfully! 🚀`));
+    console.log(chalk.cyan(`
+To get started:
+  cd ${projectName}
+  ${packageManager} run dev`));
+
+  } catch (error) {
+    spinner.fail('Setup failed.');
+    console.error(error);
+  }
+}