nitrostack 1.0.74 → 1.0.76

package/templates/typescript-pizzaz/README.md

@@ -1,6 +1,6 @@
-# 🍕 Pizzaz - Pizza Shop Finder
+# 🍕 NitroStack Pizza Shop Finder
 
-A comprehensive NitroStack template showcasing interactive pizza shop discovery with maps, lists, and detailed views. This template demonstrates the NitroStack Widget SDK for building interactive widgets.
+A comprehensive NitroStack template showcasing interactive pizza shop discovery with maps, lists, and detailed views. This template demonstrates the NitroStack Widget SDK for building beautiful, interactive widgets.
 
 ## Features
 
@@ -22,55 +22,62 @@ A comprehensive NitroStack template showcasing interactive pizza shop discovery
 - `show_pizza_list` - Show filterable list of shops
 - `show_pizza_shop` - Display detailed shop information
 
-## Quick Start
+## 🚀 Quick Start
 
-### 1. Install Dependencies
+### Prerequisites
 
 ```bash
-npm install
-cd src/widgets && npm install && cd ../..
-```
+# Install NitroStack CLI globally
+npm install -g nitrostack
 
-### 2. Configure Mapbox (Optional)
+# Or use npx
+npx nitrostack --version
+```
 
-The map widget uses Mapbox GL. To use it:
+### Setup Your Project
 
-1. Get a free API key from [Mapbox](https://www.mapbox.com/)
-2. Create `.env` file:
 ```bash
-NEXT_PUBLIC_MAPBOX_TOKEN=your_mapbox_token_here
+# Create a new project
+nitrostack init my-pizza-app --template typescript-pizzaz
+cd my-pizza-app
+
+# Install all dependencies (root + widgets)
+nitrostack install
 ```
 
-> **Note**: The template works without Mapbox, but the map widget will show an error. You can still use the list and shop widgets.
+### Configure Mapbox (Optional but Recommended)
+
+The map widget uses Mapbox GL for beautiful interactive maps:
 
-### 3. Run Development Server
+1. Get a **free** API key from [Mapbox](https://www.mapbox.com/) (sign up takes 1 minute)
+2. Create `src/widgets/.env` file:
 
 ```bash
-npm run dev
+NEXT_PUBLIC_MAPBOX_TOKEN=your_mapbox_token_here
 ```
 
-The MCP server will start on `http://localhost:3000`
-
-### 4. Run Widget Dev Server
+> **Note**: The template works without Mapbox, but the map widget will show a placeholder. You can still use the list and shop detail widgets.
 
-In a separate terminal:
+### Run Development Server
 
 ```bash
-npm run widget dev
+npm run dev
 ```
 
-Widgets will be available on `http://localhost:3001`
+This starts:
+- **MCP Server** - Hot reloads on code changes
+- **Studio** on http://localhost:3000 - Visual testing environment
+- **Widget Dev Server** on http://localhost:3001 - Hot module replacement
 
-### 5. Test in NitroStudio
+### Test in Studio
 
-1. Open NitroStudio
-2. Connect to your MCP server
-3. Try these prompts:
-   - "Show me pizza shops on a map"
-   - "List all pizza shops"
-   - "Show me details for Tony's New York Pizza"
+Try these prompts in Studio chat:
+- "Show me pizza shops on a map"
+- "List all pizza shops"
+- "Show me details for Tony's New York Pizza"
+- "Find pizza shops with high ratings"
 
-## Project Structure
+## 📁 Project Structure
 
 ```
 typescript-pizzaz/
@@ -94,7 +101,7 @@ typescript-pizzaz/
 └── README.md
 ```
 
-## Widget Features
+## 🎨 Widget Features
 
 ### Pizza Map Widget
 - **Interactive Mapbox map** with custom markers
@@ -117,7 +124,27 @@ typescript-pizzaz/
 - **Related shops** recommendations
 - **External link handling** via `useWidgetSDK()`
 
-## Customization
+## 🔧 Commands
+
+```bash
+# Installation
+npm install              # Install all dependencies (root + widgets)
+nitrostack install       # Same as above
+
+# Development
+npm run dev              # Start dev server with Studio
+npm run build            # Build TypeScript and widgets for production
+npm start                # Run production server
+
+# Upgrade
+npm run upgrade          # Upgrade nitrostack to latest version
+
+# Widget Management
+npm run widget <command> # Run npm command in widgets directory
+npm run widget add <pkg> # Add a widget dependency
+```
+
+## 🛠️ Customization
 
 ### Adding More Shops
 
@@ -160,28 +187,7 @@ style: isDark
 
 Edit `src/modules/pizzaz/pizzaz.service.ts` to add more filter options.
 
-## Deployment
-
-### Build for Production
-
-```bash
-npm run build
-```
-
-### Deploy to OpenAI ChatGPT
-
-1. Build widgets:
-```bash
-cd src/widgets && npm run build
-```
-
-2. Widget HTML files will be in `src/widgets/out/`
-
-3. Upload to your MCP server
-
-4. **Zero code changes needed!** Widgets work identically in OpenAI ChatGPT.
-
-## SDK Features Demonstrated
+## 📚 SDK Features Demonstrated
 
 ### Theme Awareness
 ```typescript
@@ -218,11 +224,24 @@ const { openExternal } = useWidgetSDK();
 openExternal('https://example.com');
 ```
 
-## Learn More
+## 🚀 Deployment
+
+### Build for Production
+
+```bash
+npm run build
+```
+
+### Deploy Widgets
+
+Widget HTML files will be generated in `src/widgets/out/` - these work identically in any MCP-compatible client including OpenAI ChatGPT.
+
+## 📚 Next Steps
 
-- [NitroStack Documentation](https://nitrostack.dev)
-- [Widget Development Guide](../../WIDGET_DEVELOPMENT.md)
-- [Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js/)
+- Try the **Starter Template** - Learn the basics
+- Try the **Flight Booking Template** - API integration with Duffel
+- Read the [NitroStack Documentation](https://nitrostack.ai/docs)
+- Check out [Mapbox GL JS Documentation](https://docs.mapbox.com/mapbox-gl-js/)
 
 ## License
 

package/templates/typescript-pizzaz/package.json

@@ -1,31 +1,32 @@
 {
-    "name": "nitrostack-pizzaz",
-    "version": "1.0.0",
-    "private": true,
-    "type": "module",
-    "description": "Pizza shop finder with interactive map - NitroStack template showcasing Widget SDK features",
-    "scripts": {
-        "dev": "nitrostack dev",
-        "build": "nitrostack build",
-        "start": "npm run build && nitrostack start",
-        "start:prod": "nitrostack start",
-        "widget": "npm --prefix src/widgets"
-    },
-    "keywords": [
-        "nitrostack",
-        "mcp",
-        "pizza",
-        "map",
-        "widgets"
-    ],
-    "author": "",
-    "license": "MIT",
-    "dependencies": {
-        "nitrostack": "^1",
-        "zod": "^3.22.4",
-        "dotenv": "^16.3.1"
-    },
-    "devDependencies": {
-        "typescript": "^5.3.3"
-    }
-}
+  "name": "nitrostack-pizzaz",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "description": "NitroStack Pizza Shop Finder - Interactive map widgets with Mapbox integration",
+  "scripts": {
+    "dev": "nitrostack dev",
+    "build": "nitrostack build",
+    "start": "npm run build && nitrostack start",
+    "start:prod": "nitrostack start",
+    "upgrade": "nitrostack upgrade",
+    "widget": "npm --prefix src/widgets"
+  },
+  "keywords": [
+    "nitrostack",
+    "mcp",
+    "pizza",
+    "map",
+    "widgets"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "nitrostack": "^1",
+    "zod": "^3.22.4",
+    "dotenv": "^16.3.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  }
+}

package/templates/typescript-starter/README.md

@@ -1,10 +1,10 @@
 # NitroStack Starter Template
 
-**The simple starter template** - Learn NitroStack v3.0 fundamentals with a clean calculator example.
+**The simple starter template** - Learn NitroStack fundamentals with a clean calculator example.
 
 ## 🎯 What's Inside
 
-This template demonstrates core NitroStack v3.0 features:
+This template demonstrates core NitroStack features:
 
 - **One Module** - Calculator module with all features
 - **One Tool** - `calculate` - Perform arithmetic operations
@@ -29,14 +29,17 @@ npx nitrostack --version
 ### Setup Your Project
 
 ```bash
+# Create a new project
 nitrostack init my-calculator --template typescript-starter
 cd my-calculator
+
+# Install all dependencies (root + widgets)
+nitrostack install
 ```
 
 That's it! The CLI automatically:
-- ✅ Installs all dependencies  
+- ✅ Installs all root dependencies  
 - ✅ Installs widget dependencies
-- ✅ Builds the widgets
 - ✅ Sets up the project structure
 
 ### Run the Project
@@ -46,11 +49,11 @@ npm run dev
 ```
 
 This starts:
-- **MCP Server** (dual transport: STDIO + HTTP on port 3002) - Hot reloads on code changes
+- **MCP Server** (dual transport: STDIO + HTTP) - Hot reloads on code changes
 - **Studio** on http://localhost:3000 - Visual testing environment
 - **Widget Dev Server** on http://localhost:3001 - Hot module replacement
 
-> 💡 **Dual Transport**: Your server exposes tools via both STDIO (for direct connections) and HTTP (for remote access on port 3002). Switch between transports in Studio → Settings.
+> 💡 **Dual Transport**: Your server exposes tools via both STDIO (for direct connections) and HTTP (for remote access). Switch between transports in Studio → Settings.
 
 The `nitrostack dev` command handles everything automatically:
 - ✅ Auto-detects widget directory
@@ -153,18 +156,23 @@ This template is perfect for learning:
 ## 🔧 Commands
 
 ```bash
+# Installation
+npm install              # Install all dependencies (root + widgets)
+nitrostack install       # Same as above
+
 # Development
-npm run dev              # Start dev server with Studio (auto-builds everything)
+npm run dev              # Start dev server with Studio
 npm run build            # Build TypeScript and widgets for production
 npm start                # Run production server
 
+# Upgrade
+npm run upgrade          # Upgrade nitrostack to latest version
+
 # Widget Management
 npm run widget <command> # Run npm command in widgets directory
 npm run widget add <pkg> # Add a widget dependency (e.g., @mui/material)
 ```
 
-**Note:** The NitroStack CLI automatically handles building, installing dependencies, and hot reload. You don't need separate commands for widgets anymore!
-
 ## 📝 Example Interactions
 
 ### Basic Calculation
@@ -284,10 +292,9 @@ nitrostack generate module converter
 
 Once you understand this template:
 
-1. Try the [E-commerce Template](/templates/ecommerce) - Advanced features with auth
-2. Read [Server Concepts](/sdk/typescript/server) - Deep dive into modules
-3. Read [Tools Guide](/sdk/typescript/tools) - Advanced tool patterns
-4. Read [Widgets Guide](/sdk/typescript/ui/widgets) - Build better UIs
+1. Try the **Pizza Shop Template** - Interactive maps and widgets
+2. Try the **Flight Booking Template** - API integration with Duffel
+3. Read the [NitroStack Documentation](https://nitrostack.ai/docs)
 
 ## 💡 Tips
 
@@ -311,4 +318,3 @@ Use this as a starting point for:
 **Happy Learning! 📖**
 
 Start simple, learn the patterns, then build something amazing!
-

package/templates/typescript-starter/package.json

@@ -1,13 +1,15 @@
 {
-  "name": "hypermcp-starter",
+  "name": "nitrostack-starter",
   "version": "1.0.0",
   "private": true,
   "type": "module",
+  "description": "NitroStack starter template - Learn MCP server basics with a simple calculator example",
   "scripts": {
     "dev": "nitrostack dev",
     "build": "nitrostack build",
     "start": "npm run build && nitrostack start",
     "start:prod": "nitrostack start",
+    "upgrade": "nitrostack upgrade",
     "widget": "npm --prefix src/widgets"
   },
   "dependencies": {