create-nexa-app 1.0.0

package/README.md

@@ -0,0 +1,273 @@
+# Nexa CLI
+
+**React Power. Angular Simplicity. Vite Speed. Cleaner UI. Prebuilt structure.**
+
+🚀 **Nexa CLI** - Powered by **Conscious Neurons LLC**  
+🌐 https://consciousneurons.com  
+Built by Salman Saeed: https://salmansaeed.us
+
+---
+
+## ✨ About Nexa CLI
+
+**Nexa CLI** is a next-generation scaffolding tool designed to give developers a **production-ready UI foundation instantly**.
+
+It combines:
+
+- ⚛️ **React Power**
+- 🧱 **Angular-style structure**
+- ⚡ **Vite Speed**
+- 🎯 **Cleaner UI with prebuilt layout system**
+
+Unlike traditional CLIs, Nexa does not just create files —  
+it gives you a **fully structured application shell** with:
+
+- Dynamic header system
+- Responsive sidebar + mobile navigation
+- Centralized route configuration
+- Styled component scaffolding
+- Modern design system (Nexa theme)
+
+---
+
+## 📦 Installation
+
+### 🔹 Option 1 — Run directly (recommended)
+
+```bash
+npx --verbose @salmansaeed/nexa@latest new app <app-name>
+```
+
+---
+
+### 🔹 Option 2 — Install globally
+
+```bash
+npm install -g @salmansaeed/nexa
+```
+
+Then use:
+
+```bash
+nexa new app <app-name>
+```
+
+---
+
+## 🚀 Creating a New App
+
+```bash
+nexa new app my-app
+```
+
+or shorthand:
+
+```bash
+nexa new my-app
+```
+
+This will:
+
+- Scaffold full React + Vite app
+- Install dependencies
+- Setup layout system
+- Configure routing + UI shell
+- Optionally start dev server
+
+---
+
+## 🧩 Core Commands
+
+| Command                   | Description                |
+| ------------------------- | -------------------------- |
+| `nexa new app <app-name>` | Create a new Nexa app      |
+| `nexa new <app-name>`     | Shortcut for creating app  |
+| `nexa new gc <name>`      | Generate component         |
+| `nexa new cc <name>`      | Generate component (alias) |
+| `nexa new svc <name>`     | Generate service           |
+| `nexa new ctx <name>`     | Generate React context     |
+
+---
+
+## ⚙️ Running the App
+
+Inside your project:
+
+```bash
+npm run nexa
+```
+
+or:
+
+```bash
+npm run dev
+```
+
+or:
+
+```bash
+npm start
+```
+
+---
+
+## 🧠 Nexa Architecture (What makes it different)
+
+### 🔹 1. Route-driven system
+
+All navigation is controlled from one place:
+
+```js
+src / config / routeMeta.js;
+```
+
+This powers:
+
+- Navbar
+- Dynamic header
+- Routing consistency
+
+---
+
+### 🔹 2. Prebuilt Layout System
+
+Every Nexa app includes:
+
+- Left sidebar (desktop)
+- Mobile header + modal navigation
+- Sticky dynamic header
+- Centered content container
+
+---
+
+### 🔹 3. Dynamic Header
+
+Headers are not hardcoded.
+
+They update automatically based on route:
+
+```js
+routeMeta["/nexa"] = {
+  title: "Nexa Page",
+  subtitle: "Generated instantly",
+};
+```
+
+---
+
+### 🔹 4. Styled Component Generation
+
+When you run:
+
+```bash
+nexa new gc MyComponent
+```
+
+You get:
+
+- Pre-styled component
+- Nexa design system applied
+- Hero section + card layout
+- Clean structure (no boilerplate mess)
+
+---
+
+### 🔹 5. Nexa Design System
+
+Every app comes with:
+
+- Dark premium theme
+- Cyan primary system color
+- Gold accent highlights
+- Glass + depth UI
+
+---
+
+## 🎯 Example Workflow
+
+```bash
+nexa new app my-platform
+cd my-platform
+npm run dev
+```
+
+Then:
+
+```bash
+nexa new gc dashboard
+nexa new svc api-service
+nexa new ctx user-session
+```
+
+---
+
+## 💡 Tips
+
+- Always run generators from project root (not inside `src`)
+- Use `routeMeta.js` to control navigation
+- Keep components minimal — Nexa already handles layout
+- Focus on logic, not setup
+
+---
+
+## 🔥 Why Nexa?
+
+Nexa is designed to eliminate:
+
+❌ repetitive setup
+❌ inconsistent UI
+❌ messy component structure
+
+And give you:
+
+✅ instant working UI
+✅ consistent architecture
+✅ scalable structure
+✅ modern design system
+
+---
+
+## 👤 Author
+
+Built and maintained by **Salman Saeed**
+🌐 [https://salmansaeed.us](https://salmansaeed.us)
+
+---
+
+## 🧠 Company
+
+**Conscious Neurons LLC**
+🌐 [https://consciousneurons.com](https://consciousneurons.com)
+
+---
+
+## 🤝 Sponsored By
+
+**Alba Gold Systems**
+🌐 [https://alba.gold](https://alba.gold)
+
+---
+
+## 🚀 Philosophy
+
+> Build fast. Stay structured. Ship clean.
+
+**Nexa = Cleaner UI + Prebuilt Structure**
+
+```
+
+---
+
+# 🔥 What changed vs SG
+
+- `sg` → `nexa`
+- added global install instructions
+- removed unused commands (`deploy`, `update`, etc.)
+- aligned with your real CLI behavior
+- added your **UI philosophy (key differentiator)**
+- explained **routeMeta system (very important for adoption)**
+
+---
+
+# 🚀 Next step (highly recommended)
+```