Skip to content
bantam.host

Examples & Recipes

Real-world examples and recipes for common deployment scenarios.

Framework Deployments

Section titled “Framework Deployments”

React Application

Section titled “React Application”

  1. Build your React app:

    Terminal window
    npm run build

  2. Deploy the build folder:

    Terminal window
    bantam deploy ./build -p -s my-react-app

  3. Your app is live at my-react-app.bantam.site

Vue.js Application

Section titled “Vue.js Application”
Terminal window
# Build for production
npm run build


# Deploy dist folder
bantam deploy ./dist -p -s my-vue-app

Next.js Static Export

Section titled “Next.js Static Export”
Terminal window
# Build and export static files
npm run build
npm run export


# Deploy the out directory
bantam deploy ./out -p -s my-nextjs-site

Astro Site

Section titled “Astro Site”
Terminal window
# Build your Astro site
npm run build


# Deploy the dist folder
bantam deploy ./dist -p

Documentation Sites

Section titled “Documentation Sites”

Deploy Docs with Custom Domain

Section titled “Deploy Docs with Custom Domain”

Perfect for project documentation:

Terminal window
# Build your docs
npm run docs:build


# Deploy to custom domain
bantam deploy ./docs/dist -d docs.myproject.com

Versioned Documentation

Section titled “Versioned Documentation”

Deploy multiple versions:

Terminal window
# Deploy v1
bantam deploy ./docs/v1 -d v1-docs.example.com


# Deploy v2
bantam deploy ./docs/v2 -d v2-docs.example.com


# Deploy latest as main
bantam deploy ./docs/latest -d docs.example.com

Development Workflows

Section titled “Development Workflows”
Section titled “Quick Preview Links”

Share work-in-progress with teammates:

Terminal window
# 1-day preview for quick feedback
bantam deploy ./preview -e 1 -s feature-preview

Staging Deployments

Section titled “Staging Deployments”
Terminal window
# Permanent staging environment
bantam deploy ./build -p -s staging-app


# Production deployment
bantam deploy ./build -p -d app.company.com

PR Preview Deployments

Section titled “PR Preview Deployments”

In your CI/CD pipeline:

.github/workflows/preview.yml
name: Deploy Preview
on: pull_request


jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm install
      - run: npm run build
      - run: npx @bantamhq/cli deploy ./dist -s pr-${{ github.event.number }}

Static Site Examples

Section titled “Static Site Examples”

Simple HTML Site

Section titled “Simple HTML Site”
Terminal window
# Deploy a basic website
bantam deploy ./my-website -p

Directory structure:

my-website/
├── index.html
├── about.html
├── css/
│   └── style.css
└── js/
    └── script.js

Landing Page

Section titled “Landing Page”
Terminal window
# Create a landing page
mkdir landing
cd landing
echo '<!DOCTYPE html>
<html>
<head>
    <title>Coming Soon</title>
    <style>
        body { font-family: sans-serif; text-align: center; padding: 50px; }
    </style>
</head>
<body>
    <h1>Coming Soon!</h1>
    <p>Something awesome is in the works.</p>
</body>
</html>' > index.html


# Deploy it
bantam deploy -p -s coming-soon

Advanced Patterns

Section titled “Advanced Patterns”

Multiple Environments

Section titled “Multiple Environments”
Terminal window
# Development
bantam deploy ./dist -s myapp-dev


# Staging
bantam deploy ./dist -s myapp-staging


# Production
bantam deploy ./dist -s myapp-prod

Automated Deployments

Section titled “Automated Deployments”

Package.json Script

Section titled “Package.json Script”
{
  "scripts": {
    "deploy": "npm run build && bantam deploy ./dist -p",
    "deploy:staging": "npm run build && bantam deploy ./dist -p -s staging",
    "deploy:prod": "npm run build && bantam deploy ./dist -p -d example.com"
  }
}

Usage:

Terminal window
npm run deploy:staging

Shell Script

Section titled “Shell Script”

Create deploy.sh:

#!/bin/bash
set -e


echo "Building project..."
npm run build


echo "Running tests..."
npm test


echo "Deploying to Bantam..."
bantam deploy ./dist -p -s production


echo "✅ Deployment complete!"

Make executable and run:

Terminal window
chmod +x deploy.sh
./deploy.sh

Special Use Cases

Section titled “Special Use Cases”

Password-Protected Preview

Section titled “Password-Protected Preview”

While Bantam doesn’t support password protection via CLI, you can:

  1. Deploy temporarily
  2. Add protection via web dashboard
  3. Share secure link
Terminal window
# Deploy for 7 days
bantam deploy ./sensitive-preview -e 7

Large File Handling

Section titled “Large File Handling”

For projects near size limits:

Terminal window
# Remove development files
rm -rf node_modules
rm -rf .git


# Create optimized archive
zip -r dist.zip dist/ -x "*.map" "*.log"


# Deploy the zip
bantam deploy dist.zip -p

Static Blog Deployment

Section titled “Static Blog Deployment”

Deploy a Jekyll or Hugo blog:

Terminal window
# Build Jekyll site
bundle exec jekyll build


# Deploy _site folder
bantam deploy ./_site -p -s my-blog

Next Steps

Section titled “Next Steps”