Add master deployment script for one-command setup

NEW SCRIPT: deploy.sh - Master deployment automation

- Tears down existing containers and volumes

- Fixes file permissions automatically

- Starts fresh containers

- Initializes database schema

- Generates test data

- Verifies deployment

- IDEMPOTENT: Safe to run multiple times

FEATURES:

- Beautiful colored output with progress indicators

- Confirmation prompt before destructive operations

- Waits for PostgreSQL to be healthy before proceeding

- Comprehensive access information at completion

- Useful commands reference

DOCUMENTATION:

- Updated README.md with Option A (one-command) and Option B (manual)

- Updated QUICKSTART.md with super quick start section

- Manual steps now in collapsible section

USER EXPERIENCE:

- Clone repo + run deploy.sh = DONE

- No more complex multi-step setup

- Perfect for demos and quick testing

- Rebuilds from scratch every time (no stale data)
This commit is contained in:
Alphaeus Mote
2025-10-24 12:18:06 -04:00
parent dc5e9f8597
commit 3e927fc5a8
3 changed files with 283 additions and 2 deletions
+30 -1
View File
@@ -1,6 +1,35 @@
# Quick Start Guide
## 🚀 Get Up and Running in 5 Minutes
## ⚡ Super Quick Start (One Command - Recommended)
```bash
# Clone the repository
git clone https://github.com/freedbygrace/SQL.git
cd SQL
# Deploy everything
chmod +x deploy.sh
./deploy.sh
```
**Done!** The master deployment script handles everything:
- ✅ Tears down old containers
- ✅ Removes old data
- ✅ Fixes permissions
- ✅ Starts containers
- ✅ Initializes database
- ✅ Generates test data
- ✅ Verifies deployment
**Time:** 15-30 minutes (mostly data generation)
Skip to [Step 4: Access the Database](#step-4-access-the-database) after deployment completes.
---
## 📋 Manual Step-by-Step (Alternative)
If you prefer to run each step manually:
### Step 0: Set Proper Permissions