create-spfx-tailwind-app 1.0.10

package/Template/README.md

@@ -0,0 +1,190 @@
+# 🚀 create-spfx-tailwind-app
+
+![npm version](https://img.shields.io/npm/v/create-spfx-tailwind-app)
+![npm downloads](https://img.shields.io/npm/dw/create-spfx-tailwind-app)
+![license](https://img.shields.io/npm/l/create-spfx-tailwind-app)
+![SPFx](https://img.shields.io/badge/SPFx-1.22+-green)
+
+A modern CLI tool to scaffold **SharePoint Framework (SPFx)** projects
+with **Tailwind CSS pre-configured** --- no manual setup required.
+
+------------------------------------------------------------------------
+
+## ✨ Features
+
+-   ⚡ One-command SPFx project creation\
+-   🎨 Tailwind CSS ready out of the box\
+-   🧠 Smart CLI (interactive prompts + flags)\
+-   📦 Optional dependency installation\
+-   🏗 Built for SPFx v1.22+ (Heft-based projects)\
+-   🔁 No manual renaming required
+
+------------------------------------------------------------------------
+
+## 📦 Usage
+
+### ▶️ Create a project
+
+``` bash
+npx create-spfx-tailwind-app MyProject
+```
+
+------------------------------------------------------------------------
+
+### ▶️ Or install globally
+
+``` bash
+npm install -g create-spfx-tailwind-app
+create-spfx-app MyProject
+```
+
+------------------------------------------------------------------------
+
+## ⚙️ CLI Options
+
+``` bash
+create-spfx-app <project-name> [options]
+```
+
+### Options
+
+-   `--no-install` → Skip dependency installation
+
+### Example
+
+``` bash
+create-spfx-app VendorPortal --no-install
+```
+
+------------------------------------------------------------------------
+
+## 🛠 After Project Creation
+
+### If you skipped install:
+
+``` bash
+cd MyProject
+npm install
+```
+
+------------------------------------------------------------------------
+
+## ▶️ Start Development
+
+Run in **two terminals**:
+
+``` bash
+# Terminal 1
+npm run start
+```
+
+``` bash
+# Terminal 2 (Tailwind watcher)
+npm run build:tailwind
+```
+
+------------------------------------------------------------------------
+
+## 🧱 Tech Stack
+
+-   SharePoint Framework (SPFx) v1.22+
+-   React
+-   Tailwind CSS
+-   Heft build system
+-   Node.js
+
+------------------------------------------------------------------------
+
+## 📁 Project Structure
+
+    MyProject/
+    ├── src/
+    ├── config/
+    ├── package.json
+    ├── gulpfile.js
+    ├── tailwind.config.js
+
+------------------------------------------------------------------------
+
+## 🎯 Why this tool?
+
+The default SPFx generator:
+
+``` bash
+yo @microsoft/sharepoint
+```
+
+❌ Requires manual setup\
+❌ No Tailwind support\
+❌ Repetitive configuration
+
+------------------------------------------------------------------------
+
+This CLI solves that by:
+
+✔ Automating setup\
+✔ Adding Tailwind out of the box\
+✔ Improving developer experience
+
+------------------------------------------------------------------------
+
+## 📌 Prerequisites
+
+-   Node.js (v18 recommended)
+-   npm
+-   SPFx development environment
+
+------------------------------------------------------------------------
+
+## 🧪 Example
+
+``` bash
+npx create-spfx-tailwind-app VendorPortal
+```
+
+------------------------------------------------------------------------
+
+## 🧑‍💻 Author
+
+Deependra Singh
+
+------------------------------------------------------------------------
+
+## 📄 License
+
+MIT License
+
+------------------------------------------------------------------------
+
+## ⚠️ Disclaimer
+
+This project is not officially affiliated with Microsoft.\
+Use at your own risk.
+
+------------------------------------------------------------------------
+
+## ⭐ Contributing
+
+Contributions are welcome!\
+Feel free to open issues or submit pull requests.
+
+------------------------------------------------------------------------
+
+## 🔗 References
+
+-   https://learn.microsoft.com/sharepoint/dev/spfx/
+-   https://tailwindcss.com/
+-   https://heft.rushstack.io/
+
+------------------------------------------------------------------------
+
+## 💬 Support
+
+If you find this useful:
+
+⭐ Star the repo\
+🔁 Share with your team
+
+------------------------------------------------------------------------
+
+Happy coding 🚀

package/Template/config/config.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "version": "2.0",
+  "bundles": {
+    "template-spfx-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/__PROJECT_NAME_LOWER__/__PROJECT_NAME__WebPart.js",
+          "manifest": "./src/webparts/__PROJECT_NAME_LOWER__/__PROJECT_NAME__WebPart.manifest.json"
+        }
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "TemplateSpfxWebPartStrings": "lib/webparts/__PROJECT_NAME_LOWER__/loc/{locale}.js"
+  }
+}

package/Template/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./release/assets/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "__PROJECT_NAME__",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

package/Template/config/package-solution.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "__PROJECT_NAME__-client-side-solution",
+    "id": "5ee544fa-223e-415c-a17c-3555c718f10d",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true,
+    "skipFeatureDeployment": true,
+    "isDomainIsolated": false,
+    "developer": {
+      "name": "",
+      "websiteUrl": "",
+      "privacyUrl": "",
+      "termsOfUseUrl": "",
+      "mpnId": "Undefined-1.22.2"
+    },
+    "metadata": {
+      "shortDescription": {
+        "default": "__PROJECT_NAME__ description"
+      },
+      "longDescription": {
+        "default": "__PROJECT_NAME__ description"
+      },
+      "screenshotPaths": [],
+      "videoUrl": "",
+      "categories": []
+    },
+    "features": [
+      {
+        "title": "__PROJECT_NAME__ Feature",
+        "description": "The feature that activates elements of the __PROJECT_NAME__ solution.",
+        "id": "a6af1389-ba38-489b-b24c-f2c36e5ed404",
+        "version": "1.0.0.0"
+      }
+    ]
+  },
+  "paths": {
+    "zippedPackage": "solution/__PROJECT_NAME__.sppkg"
+  }
+}

package/Template/config/rig.json

@@ -0,0 +1,7 @@
+{
+  // The "rig.json" file directs tools to look for their config files in an external package.
+  // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+
+  "rigPackageName": "@microsoft/spfx-web-build-rig"
+}

package/Template/config/sass.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft-sass-plugin.schema.json",
+
+  "extends": "@microsoft/spfx-web-build-rig/profiles/default/config/sass.json"
+}

package/Template/config/serve.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
+}

package/Template/config/typescript.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@microsoft/spfx-web-build-rig/profiles/default/config/typescript.json",
+
+  "staticAssetsToCopy": {
+    "fileExtensions": [".resx", ".jpg", ".png", ".woff", ".eot", ".ttf", ".svg", ".gif"],
+
+    "includeGlobs": ["webparts/*/loc/*.js"]
+  }
+}

package/Template/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}