@qobo/deploy

Deploy React/Vite projects to qobo-deployments (S3 + CloudFront/Cloudflare).
Works for both new projects (first deploy) and updates (redeploying existing projects).

Requirements

• Node.js 18+
• qobo-deployments service running (S3 + CDN configured)
• API key for qobo-deployments

Installation

As a dev dependency (recommended)

npm install -D @qobo/deploy

Add to package.json scripts:

{
  "scripts": {
    "deploy": "qobo-deploy"
  }
}

Or use with npx (no install)

npx @qobo/deploy

Usage

From the project root (where package.json is):

npm run deploy
# or
npx qobo-deploy

Options

| Option | Description | |--------------|-------------------------------------| | --name app | Override project name (S3 subdomain)| | --dry-run | Show what would be deployed (no API call) | | --help | Show help |

Examples

# Deploy current project (name from package.json)
npm run deploy

# Deploy with custom project name
npx qobo-deploy --name my-app

# Dry run (no API call)
npx qobo-deploy --dry-run

Configuration

Environment variables

| Variable | Description | Example | |------------------------|---------------------------------|-------------------------------| | QOBO_DEPLOY_API_URL | qobo-deployments API base URL | https://api.qobo.dev | | QOBO_DEPLOY_API_KEY | API key (required) | your-secure-api-key | | API_URL, API_KEY | Aliases for above | |

Optional config file

Create qobo.deploy.json in the project root:

{
  "projectName": "my-app",
  "apiUrl": "https://api.qobo.dev",
  "apiKey": "your-api-key",
  "framework": "vite",
  "buildCommand": "npm run build",
  "outputDirectory": "dist"
}

Or add to package.json:

{
  "name": "my-app",
  "qobo": {
    "projectName": "my-app",
    "framework": "vite",
    "outputDirectory": "dist"
  }
}

Project name

• Must be lowercase, numbers, hyphens only
• Default: package.json name (sanitized)
• Override: --name flag or projectName in config
• Used as S3 prefix and subdomain: {projectName}.qobo.dev

What happens

1. Collects source files (excludes node_modules, dist, .git, etc.)
2. Sends them to qobo-deployments API
3. qobo-deployments builds and uploads to S3 + invalidates CDN
4. Live URL: https://{projectName}.qobo.dev

Local development

If you're developing this package locally (e.g. from the qobo repo):

cd qobo-deploy
npm link
cd /path/to/your/project
npm link @qobo/deploy
npm run deploy

Or run directly:

node /path/to/qobo-deploy/src/cli.js

License

MIT