Skip to content

DEPLOY_GITHUB.md

Latest commit

 

History

History
107 lines (75 loc) · 2.46 KB

DEPLOY_GITHUB.md

File metadata and controls

107 lines (75 loc) · 2.46 KB

🚀 Deploy to GitHub Pages - Step by Step

Quick Start (5 Minutes)

Step 1: Update Repository Name

  1. Open index.html
  2. Find all instances of:
    • yourusername → Replace with your GitHub username
    • mobile-car-wash-manager → Replace with your repository name
  3. Save the file

Step 2: Create GitHub Repository

  1. Go to: https://github.com/new
  2. Repository name: mobile-car-wash-manager (or your choice)
  3. Make it Public (required for free GitHub Pages)
  4. Click Create repository

Step 3: Push Your Code

# Initialize git (if not already)
git init

# Add all files
git add .

# Commit
git commit -m "Initial commit - Mobile Car Wash Manager"

# Add remote (replace with your repo URL)
git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git

# Push to GitHub
git branch -M main
git push -u origin main

Step 4: Enable GitHub Pages

  1. Go to your repository on GitHub
  2. Click Settings tab
  3. Scroll to Pages (left sidebar)
  4. Under Source:
    • Select: GitHub Actions (recommended)
    • OR: Deploy from a branch → Select main → / (root)
  5. Click Save

Step 5: Wait for Deployment

  • GitHub Actions will automatically build and deploy
  • Takes 2-5 minutes
  • Check Actions tab to see progress

Step 6: Access Your App

Your app will be live at:

https://YOUR_USERNAME.github.io/YOUR_REPO_NAME/

🔄 Automatic Updates

Every time you push to main branch:

  1. GitHub Actions automatically builds
  2. Deploys to GitHub Pages
  3. Your app updates automatically!

📝 Manual Deployment (Alternative)

If you prefer manual deployment:

# Build for GitHub Pages
npm run build:github

# Deploy
npm run deploy:github

This creates a gh-pages branch with your built app.

✅ Verification

After deployment, verify:

  1. App loads: Visit your GitHub Pages URL
  2. Installation works: Test on mobile/desktop
  3. Meta tags: Use validators (see below)
  4. PWA: Check service worker is registered

🔍 Meta Tag Validators

🎉 Done!

Your app is now live on GitHub Pages with:

  • ✅ Complete meta tags
  • ✅ SEO optimization
  • ✅ Social sharing
  • ✅ PWA support
  • ✅ Auto-deployment