@gv-sh/specgen-app 0.3.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # SpecGen App - Complete Platform
 
-[![Version](https://img.shields.io/badge/version-0.3.0-blue.svg)](https://github.com/gv-sh/specgen-app)
+[![Version](https://img.shields.io/badge/version-0.4.0-blue.svg)](https://github.com/gv-sh/specgen-app)
 
 A unified deployment package for the SpecGen speculative fiction generator platform.
 
@@ -12,6 +12,25 @@ A unified deployment package for the SpecGen speculative fiction generator platf
 
 ## Quick Start
 
+### Using NPX (Recommended)
+
+```bash
+# Create and enter your project directory
+mkdir specgen-project
+cd specgen-project
+
+# Run setup directly with npx
+npx @gv-sh/specgen-app setup
+
+# Start in development mode
+npx @gv-sh/specgen-app dev
+
+# Or start in production mode
+npx @gv-sh/specgen-app production
+```
+
+### Using NPM Scripts
+
 1. **Setup**:
    ```bash
    npm run setup
@@ -36,15 +55,127 @@ A unified deployment package for the SpecGen speculative fiction generator platf
 - Admin Interface: http://localhost:3001
 - API: http://localhost:3000
 
-## Production Deployment
+## Deployment Options
+
+### Option 1: Quick NPX 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
+   # 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:3002
+   - Admin Interface: http://your-server-ip:3001
+   - API: http://your-server-ip:3000
+
+### Option 2: Global NPM Package Deployment
+
+#### 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
+   specgen-app setup
+   ```
+   During setup, you'll be prompted to enter your OpenAI API key.
+
+4. **Start the application**:
+   - Development mode: `specgen-app dev`
+   - Production mode: `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
+   ```
 
-### Build
+3. **Create a project directory**:
+   ```bash
+   mkdir specgen
+   cd specgen
+   ```
+
+4. **Install SpecGen globally**:
+   ```bash
+   npm install -g @gv-sh/specgen-app
+   ```
+
+5. **Setup the application**:
+   ```bash
+   specgen-app setup
+   ```
+
+6. **Start in production mode**:
+   ```bash
+   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:
@@ -58,6 +189,28 @@ sudo ./deploy.sh
 
 ## Management Commands
 
+When using NPX or global installation:
+```bash
+# Check status
+npx @gv-sh/specgen-app deploy:status
+# or when installed globally
+specgen-app deploy:status
+
+# Stop services
+npx @gv-sh/specgen-app deploy:stop
+# or
+specgen-app deploy:stop
+
+# Restart services
+npx @gv-sh/specgen-app deploy:restart
+# or
+specgen-app deploy:restart
+
+# Update to latest version
+npm update -g @gv-sh/specgen-app
+```
+
+When using the repository:
 ```bash
 # Stop services
 npm run deploy:stop
@@ -75,11 +228,33 @@ npm run deploy:status
 npm run deploy:backup
 ```
 
+## Available Commands
+
+The following commands are available when using `npx @gv-sh/specgen-app` or `specgen-app` (if installed globally):
+
+- `setup` - Set up the SpecGen application
+- `production` - Run the application in production mode
+- `dev` - Run the application in development mode
+- `deploy` - Deploy the application
+- `deploy:stop` - Stop the deployed application
+- `deploy:restart` - Restart the deployed application
+- `deploy:update` - Update the deployed application
+- `deploy:status` - Check the status of the deployed application
+- `deploy:backup` - Create a backup of the deployed application
+- `troubleshoot` - Run troubleshooting checks
+
 ## Troubleshooting
 
 If you encounter issues:
 
 ```bash
+# Using npx
+npx @gv-sh/specgen-app troubleshoot
+
+# Using global installation
+specgen-app troubleshoot
+
+# For repository installation
 npm run troubleshoot
 ```
 
@@ -87,4 +262,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/bin/cli.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+// Find the root directory of the package
+const findPackageRoot = () => {
+  // When installed as a dependency, the package will be in node_modules/@gv-sh/specgen-app
+  // When running directly from the package, we're already at the root
+  const packageJsonPath = path.resolve(__dirname, '../package.json');
+  
+  if (fs.existsSync(packageJsonPath)) {
+    return path.dirname(packageJsonPath);
+  }
+  
+  throw new Error('Could not locate package root directory');
+};
+
+const runScript = (scriptName) => {
+  try {
+    const packageRoot = findPackageRoot();
+    process.chdir(packageRoot);
+    
+    console.log(`📦 Running ${scriptName} script...`);
+    execSync(`npm run ${scriptName}`, { stdio: 'inherit' });
+    
+    console.log(`✅ ${scriptName} completed successfully`);
+  } catch (error) {
+    console.error(`❌ Error during ${scriptName}:`, error.message);
+    process.exit(1);
+  }
+};
+
+const command = process.argv[2];
+
+switch (command) {
+  case 'setup':
+    runScript('setup');
+    break;
+  case 'production':
+    runScript('production');
+    break;
+  case 'dev':
+    runScript('dev');
+    break;
+  case 'deploy':
+    runScript('deploy');
+    break;
+  case 'deploy:stop':
+    runScript('deploy:stop');
+    break;
+  case 'deploy:restart':
+    runScript('deploy:restart');
+    break;
+  case 'deploy:update':
+    runScript('deploy:update');
+    break;
+  case 'deploy:status':
+    runScript('deploy:status');
+    break;
+  case 'deploy:backup':
+    runScript('deploy:backup');
+    break;
+  case 'troubleshoot':
+    runScript('troubleshoot');
+    break;
+  default:
+    console.log('Usage: specgen-app <command>');
+    console.log('\nAvailable commands:');
+    console.log('  setup           - Set up the SpecGen application');
+    console.log('  production      - Run the application in production mode');
+    console.log('  dev             - Run the application in development mode');
+    console.log('  deploy          - Deploy the application');
+    console.log('  deploy:stop     - Stop the deployed application');
+    console.log('  deploy:restart  - Restart the deployed application');
+    console.log('  deploy:update   - Update the deployed application');
+    console.log('  deploy:status   - Check the status of the deployed application');
+    console.log('  deploy:backup   - Create a backup of the deployed application');
+    console.log('  troubleshoot    - Run troubleshooting checks');
+}

package/index.js

@@ -0,0 +1,14 @@
+// This file makes the package importable
+// The main functionality is provided through the CLI
+
+module.exports = {
+  version: require('./package.json').version,
+  description: 'SpecGen Application Package',
+  
+  // Export script paths for programmatic access
+  scripts: {
+    setup: require.resolve('./scripts/setup.sh'),
+    dev: require.resolve('./scripts/dev.sh'),
+    production: require.resolve('./scripts/production.sh')
+  }
+};

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@gv-sh/specgen-app",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Complete SpecGen application with server, admin, and user interfaces",
   "main": "index.js",
+  "bin": {
+    "specgen-app": "./bin/cli.js"
+  },
   "scripts": {
     "setup": "chmod +x scripts/setup.sh && ./scripts/setup.sh",
     "dev": "chmod +x scripts/dev.sh && ./scripts/dev.sh",
@@ -16,7 +19,8 @@
     "deploy:update": "chmod +x scripts/update.sh && ./scripts/update.sh",
     "deploy:status": "chmod +x scripts/status.sh && ./scripts/status.sh",
     "deploy:backup": "chmod +x scripts/backup.sh && ./scripts/backup.sh",
-    "troubleshoot": "chmod +x scripts/troubleshoot.sh && ./scripts/troubleshoot.sh"
+    "troubleshoot": "chmod +x scripts/troubleshoot.sh && ./scripts/troubleshoot.sh",
+    "postinstall": "chmod +x bin/cli.js"
   },
   "dependencies": {
     "@gv-sh/specgen-server": "0.9.0",

package/scripts/make-executable.sh

@@ -1,6 +1,12 @@
 #!/bin/bash
 
-# Make all scripts executable
-chmod +x scripts/*.sh
+# SpecGen Package Deployment Script
+echo "📦 Making files executable..."
 
-echo "✅ All scripts are now executable"
+# Make all shell scripts executable
+find scripts -name "*.sh" -exec chmod +x {} \;
+
+# Make CLI executable
+chmod +x bin/cli.js
+
+echo "✅ All scripts are now executable"