create-react-scaffold-cli 0.1.2 → 1.0.1

package/README.md

@@ -0,0 +1,35 @@
+# create-react-scaffold-cli
+
+A CLI to scaffold a **feature-first React application** with clear boundaries and long-term maintainability.
+
+This scaffold enforces a simple rule:
+
+> **Business logic lives in features.  
+> Reusable primitives live in shared.  
+> App only wires things together.**
+
+---
+
+## Why this exists
+
+Most React projects slowly degrade into:
+
+- unclear ownership
+- massive `components/` folders
+- bloated `shared/` directories
+- fragile cross-feature imports
+
+This scaffold exists to:
+
+- enforce **feature ownership**
+- make refactoring safe
+- allow deleting features without breaking the app
+- keep architecture understandable as the app grows
+
+---
+
+## Quick Start
+
+```bash
+npx create-react-scaffold-cli
+```

package/package.json

@@ -1,23 +1,35 @@
 {
   "name": "create-react-scaffold-cli",
-  "version": "0.1.2",
-  "type": "module",
-  "bin": {
-    "create-react-scaffold": "bin/index.js"
-  },
-  "dependencies": {
-    "commander": "^14.0.2",
-    "execa": "^9.6.1",
-    "fs-extra": "^11.3.3",
-    "prompts": "^2.4.2"
+  "version": "1.0.1",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
-    "npx",
     "cli",
     "react",
     "scaffold",
     "boilerplate",
+    "vite",
+    "frontend",
     "create-app",
-    "vite"
+    "react-architecture"
+  ],
+  "author": "Muhammad Arsalan",
+  "license": "ISC",
+  "description": "A CLI to scaffold a feature-first React application with clear boundaries and long-term maintainability.",
+  "dependencies": {
+    "commander": "^14.0.2",
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.3",
+    "prompts": "^2.4.2"
+  },
+  "bin": {
+    "create-react-scaffold-cli": "bin/index.js"
+  },
+  "files": [
+    "bin",
+    "scripts",
+    "templates"
   ]
 }

package/scripts/createProject.js

@@ -1,5 +1,5 @@
-import path from 'path';
 import fs from 'fs-extra';
+import path from 'path';
 import { execa } from 'execa';
 import { fileURLToPath } from 'url';
 
@@ -13,6 +13,7 @@ export async function createProject(name, options) {
   const templateDir = path.resolve(__dirname, '../templates/base');
 
   console.log(`📁 Creating project: ${name}`);
+
   await fs.copy(templateDir, targetDir);
 
   if (installDeps) {
@@ -23,7 +24,7 @@ export async function createProject(name, options) {
     });
   } else {
     console.log('⏭ Skipped dependency installation');
-    console.log(`➡ Run 'npm install' inside ${name} when ready`);
+    console.log(`➡ Run 'npm install' inside ${name}`);
   }
 
   console.log('✅ Project ready!');

package/templates/base/readme.md

@@ -65,13 +65,11 @@ Each top-level folder has **its own README** explaining rules and responsibiliti
 
 ## Installation (WIP)
 
-> CLI installation instructions will be added once the NPM package is published.
-
-For now:
+> CLI installation instructions.
 
 ```bash
-npm install
-npm run dev
+npx create-react-scaffold-cli
+
 ```
 
 ---

package/templates/base/src/shared/constants/app.constants.js

@@ -1,4 +1,3 @@
 export const ENV = {
   BACKEND_URL: import.meta.env.VITE_BACKEND_URL,
 };
-

package/templates/base/.env

@@ -1 +0,0 @@
-VITE_BACKEND_URL=""