@gv-sh/specgen-app 0.1.6 → 0.3.1

package/.github/workflows/release.yml

@@ -39,10 +39,22 @@ jobs:
       - name: Install dependencies
         run: npm install
       
-      - name: Test setup process
+      - name: Test setup and production process
         run: |
-          # Run setup to verify everything works
-          npm run setup
+          # Create an automated setup process for CI environment
+          mkdir -p server
+          
+          # Create a CI-specific .env file with a dummy API key
+          echo "OPENAI_API_KEY=sk-test1234\nNODE_ENV=test\nPORT=3000" > server/.env
+          
+          # Run normal setup with the environment variable to indicate CI mode
+          CI=true npm run setup
+          
+          # Make scripts executable
+          npm run make-executable
+          
+          # Test production script in CI mode
+          CI=true timeout 10s ./scripts/production.sh || true
           
           # Verify all components are extracted
           if [ ! -d "server" ]; then

package/README.md

@@ -1,6 +1,6 @@
 # SpecGen App - Complete Platform
 
-[![Version](https://img.shields.io/badge/version-0.1.6-blue.svg)](https://github.com/gv-sh/specgen-app)
+[![Version](https://img.shields.io/badge/version-0.3.1-blue.svg)](https://github.com/gv-sh/specgen-app)
 
 A unified deployment package for the SpecGen speculative fiction generator platform.
 
@@ -16,29 +16,149 @@ A unified deployment package for the SpecGen speculative fiction generator platf
    ```bash
    npm run setup
    ```
+   During setup, you'll be prompted to enter your OpenAI API key.
 
-2. **Add OpenAI API Key** to `server/.env`
+2. **Add OpenAI API Key** to `server/.env` if you skipped during setup
 
 3. **Start Development**:
    ```bash
    npm run dev
    ```
 
+4. **Start Production** (optimized build with API key validation):
+   ```bash
+   npm run production
+   ```
+
 ## Access URLs
 
 - User Interface: http://localhost:3002
 - Admin Interface: http://localhost:3001
 - API: http://localhost:3000
 
-## Production Deployment
+## Deployment Options
+
+### Option 1: Quick NPM Deployment to Remote Server
+
+If you have SSH access to a server (like an EC2 instance), this is the fastest way to deploy:
+
+1. **Save your SSH key** to a file (e.g., `key.pem`) and set permissions:
+   ```bash
+   chmod 400 key.pem
+   ```
+
+2. **SSH into your server**:
+   ```bash
+   ssh -i "key.pem" ubuntu@your-server-ip
+   ```
+
+3. **Install Node.js 18 or higher**:
+   ```bash
+   curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
+   sudo apt-get install -y nodejs
+   ```
+
+4. **Install and run SpecGen**:
+   ```bash
+   # Install globally
+   sudo npm install -g @gv-sh/specgen-app
+   
+   # Create and enter project directory
+   mkdir specgen
+   cd specgen
+   
+   # Run the setup
+   npx @gv-sh/specgen-app setup
+   
+   # Start in production mode
+   npx @gv-sh/specgen-app production
+   ```
+
+5. **Keep the service running with PM2** (recommended):
+   ```bash
+   sudo npm install -g pm2
+   pm2 start "npx @gv-sh/specgen-app production" --name "specgen"
+   pm2 startup
+   pm2 save
+   ```
+
+6. **Access your application**:
+   - User Interface: http://your-server-ip:3000
+   - Admin Interface: http://your-server-ip:3000/admin
+
+### Option 2: NPM Package Deployment (Detailed)
+
+#### Local Machine Deployment
+
+1. **Install globally** (recommended for deployment):
+   ```bash
+   npm install -g @gv-sh/specgen-app
+   ```
+
+2. **Create a project directory**:
+   ```bash
+   mkdir specgen-project
+   cd specgen-project
+   ```
+
+3. **Initialize and setup**:
+   ```bash
+   npx @gv-sh/specgen-app setup
+   ```
+   During setup, you'll be prompted to enter your OpenAI API key.
+
+4. **Start the application**:
+   - Development mode: `npx @gv-sh/specgen-app dev`
+   - Production mode: `npx @gv-sh/specgen-app production`
+
+#### Remote Server Deployment
+
+1. **SSH into your server**:
+   ```bash
+   ssh -i "your-key.pem" username@your-server
+   ```
+
+2. **Install Node.js** (if not already installed):
+   ```bash
+   curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
+   sudo apt-get install -y nodejs
+   ```
+
+3. **Create a project directory**:
+   ```bash
+   mkdir specgen
+   cd specgen
+   ```
+
+4. **Install SpecGen**:
+   ```bash
+   npm install @gv-sh/specgen-app
+   ```
 
-### Build
+5. **Setup the application**:
+   ```bash
+   npx @gv-sh/specgen-app setup
+   ```
+
+6. **Start in production mode**:
+   ```bash
+   npx @gv-sh/specgen-app production
+   ```
+
+### Option 3: Manual Deployment
+
+Alternatively, you can deploy manually using the repository:
+
+#### Build and Run Locally
 ```bash
+git clone https://github.com/gv-sh/specgen-app.git
+cd specgen-app
+npm run setup
 npm run build
-npm start
+npm run production
 ```
 
-### AWS Deployment
+#### AWS Deployment Script
 
 1. Launch Ubuntu 22.04 instance with SSH access
 2. Run deployment script:
@@ -52,6 +172,19 @@ sudo ./deploy.sh
 
 ## Management Commands
 
+When using NPM global installation:
+```bash
+# Check status
+npx @gv-sh/specgen-app status
+
+# Stop services
+npx @gv-sh/specgen-app stop
+
+# Update to latest version
+npm update -g @gv-sh/specgen-app
+```
+
+When using the repository:
 ```bash
 # Stop services
 npm run deploy:stop
@@ -74,6 +207,10 @@ npm run deploy:backup
 If you encounter issues:
 
 ```bash
+# For global NPM installation
+npx @gv-sh/specgen-app troubleshoot
+
+# For repository installation
 npm run troubleshoot
 ```
 
@@ -81,4 +218,4 @@ This will check your setup and identify common problems.
 
 ## Environment Variables
 
-The setup script creates necessary environment files automatically. You only need to add your OpenAI API key to `server/.env`.
+The setup script creates necessary environment files automatically. You only need to add your OpenAI API key during setup or later to `server/.env`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gv-sh/specgen-app",
-  "version": "0.1.6",
+  "version": "0.3.1",
   "description": "Complete SpecGen application with server, admin, and user interfaces",
   "main": "index.js",
   "scripts": {
@@ -8,6 +8,8 @@
     "dev": "chmod +x scripts/dev.sh && ./scripts/dev.sh",
     "build": "cd admin && npm run build && cd ../user && npm run build",
     "start": "cd server && npm start",
+    "production": "chmod +x scripts/production.sh && ./scripts/production.sh",
+    "make-executable": "chmod +x scripts/make-executable.sh && ./scripts/make-executable.sh",
     "deploy": "chmod +x scripts/deploy.sh && ./scripts/deploy.sh",
     "deploy:stop": "chmod +x scripts/stop.sh && ./scripts/stop.sh",
     "deploy:restart": "chmod +x scripts/restart.sh && ./scripts/restart.sh",

package/scripts/make-executable.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# Make all scripts executable
+chmod +x scripts/*.sh
+
+echo "✅ All scripts are now executable"

package/scripts/production.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+
+# SpecGen Production Script
+set -e
+
+echo "🚀 Starting SpecGen in production mode..."
+
+# Function to check if port is available
+check_port() {
+    local port=$1
+    if lsof -Pi :$port -sTCP:LISTEN -t >/dev/null 2>&1; then
+        return 1  # Port in use
+    else
+        return 0  # Port available
+    fi
+}
+
+# Verify OpenAI API key
+if [ -f "server/.env" ]; then
+    # In CI mode, skip API key validation
+    if [ "$CI" = "true" ]; then
+        echo "CI mode detected - skipping API key validation"
+    elif grep -q "OPENAI_API_KEY=your_openai_api_key_here" server/.env; then
+        echo "⚠️ No OpenAI API key detected!"
+        echo "Enter your OpenAI API key: "
+        read -r OPENAI_KEY
+        
+        if [ -z "$OPENAI_KEY" ]; then
+            echo "❌ No API key provided. Cannot start in production mode."
+            exit 1
+        else
+            # Update the API key in the .env file
+            sed -i.bak "s/OPENAI_API_KEY=.*/OPENAI_API_KEY=$OPENAI_KEY/" server/.env
+            rm -f server/.env.bak
+            echo "✅ API key updated in server/.env"
+        fi
+    fi
+else
+    echo "❌ server/.env file not found. Run 'npm run setup' first."
+    exit 1
+fi
+
+# Verify directories exist
+for dir in server admin user; do
+    if [ ! -d "$dir" ]; then
+        echo "❌ $dir directory not found. Run 'npm run setup' first."
+        exit 1
+    fi
+done
+
+# Check if dependencies are installed
+for dir in server admin user; do
+    if [ ! -d "$dir/node_modules" ]; then
+        echo "Installing $dir dependencies..."
+        cd "$dir" && npm install
+        cd ..
+    fi
+done
+
+# Set production environment
+export NODE_ENV=production
+
+echo "Building web interfaces..."
+# Build React apps for production
+cd admin && npm run build && cd ..
+cd user && npm run build && cd ..
+
+# Create production-ready .env for server
+cat > server/.env.production << EOF
+$(cat server/.env)
+NODE_ENV=production
+EOF
+
+# Kill existing processes on required ports if needed
+echo "Checking ports..."
+for port in 3000 3001 3002; do
+    if ! check_port $port; then
+        echo "Port $port is in use. Attempting to free it..."
+        lsof -ti:$port | xargs kill -9 2>/dev/null || true
+        sleep 1
+    fi
+done
+
+# Start production server
+echo "Starting production server..."
+if [ "$CI" = "true" ]; then
+    echo "CI mode detected - skipping server start"
+else
+    cd server && NODE_ENV=production npm start
+fi

package/scripts/setup.sh

@@ -107,14 +107,50 @@ done
 echo "🔧 Setting up environment files..."
 
 # Server .env
-if [ ! -f server/.env ]; then
-    cat > server/.env << 'EOF'
-# Add your OpenAI API key here
-OPENAI_API_KEY=your_openai_api_key_here
+if [ ! -f server/.env ] || [ "$CI" = "true" ]; then
+    # If in CI mode, use a dummy key
+    if [ "$CI" = "true" ]; then
+        # If in CI environment and .env already exists, just use it
+        if [ -f server/.env ]; then
+            echo "Using existing .env file for CI environment"
+        else
+            # Create a CI .env file
+            cat > server/.env << EOF
+OPENAI_API_KEY=sk-test1234
+NODE_ENV=test
+PORT=3000
+EOF
+            echo "Created test .env file for CI environment"
+        fi
+        KEY_PROVIDED=true
+    else
+        # Normal interactive mode
+        # Prompt for OpenAI API key
+        echo "To use SpecGen, you need an OpenAI API key."
+        echo "Enter your OpenAI API key (or press enter to set it later): "
+        read -r OPENAI_KEY
+        
+        # If key is provided, use it, otherwise use placeholder
+        if [ -z "$OPENAI_KEY" ]; then
+            OPENAI_KEY="your_openai_api_key_here"
+            KEY_PROVIDED=false
+        else
+            KEY_PROVIDED=true
+        fi
+        
+        cat > server/.env << EOF
+# OpenAI API key
+OPENAI_API_KEY=$OPENAI_KEY
 NODE_ENV=development
 PORT=3000
 EOF
-    echo "Created server/.env - Please add your OpenAI API key"
+        
+        if [ "$KEY_PROVIDED" = true ]; then
+            echo "✅ OpenAI API key saved to server/.env"
+        else
+            echo "⚠️ No OpenAI API key provided. You'll need to add it later to server/.env"
+        fi
+    fi
 fi
 
 # Admin .env.development  
@@ -140,8 +176,12 @@ fi
 echo "✅ Setup complete!"
 echo ""
 echo "Next steps:"
-echo "1. Add your OpenAI API key to server/.env"
-echo "2. Run 'npm run dev' to start all services"
+if [ "$KEY_PROVIDED" = false ]; then
+    echo "1. Add your OpenAI API key to server/.env"
+    echo "2. Run 'npm run dev' to start all services"
+else
+    echo "1. Run 'npm run dev' to start all services"
+fi
 echo ""
 echo "Access URLs:"
 echo "  🌐 User Interface: http://localhost:3002"