mirror of
https://github.com/freedbygrace/SQL.git
synced 2026-07-26 19:38:16 +00:00
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:
+30
-1
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user