# GMLM Platform — Quick Start Guide

## ⚡ 30-Second Setup

### Option 1: Docker (Recommended — no PHP/Node needed locally)

```bash
# 1. Extract the ZIP
# 2. Open terminal in the extracted folder
# 3. Run:

docker compose up -d

# 4. Open browser: http://localhost
# The installer opens automatically
```

---

### Option 2: Linux / macOS

```bash
# Open terminal in the extracted folder
chmod +x setup.sh
./setup.sh
```

---

### Option 3: Windows

```
Double-click setup.bat
```

---

### Option 4: Shared Hosting (cPanel / Plesk)

1. Upload the ZIP to your server via File Manager or FTP
2. Extract to a folder above `public_html` (e.g. `/home/user/gmlm/`)
3. Copy contents of `public/` into `public_html/`
4. In cPanel → PHP: set version to **8.3+**
5. SSH in and run: `composer install --no-dev`
6. Visit `https://yourdomain.com` — installer opens

---

## What Setup Does

Running `setup.sh` / `setup.bat` / Docker automatically:

| Step | What Happens |
|------|-------------|
| 1 | Checks PHP 8.3+, Composer, Node 20+ |
| 2 | Runs `composer install` (installs Laravel + all PHP packages) |
| 3 | Runs `npm install && npm run build` (builds Vue/Tailwind frontend) |
| 4 | Copies `.env.example` → `.env` |
| 5 | Generates secure `APP_KEY` |
| 6 | Opens browser at `http://localhost` |

---

## After Setup — Follow the Installer

The 5-step web installer handles everything else:

```
Step 1 → Requirements check (auto-passes after setup)
Step 2 → Enter your MySQL database credentials
Step 3 → Create your admin account
Step 4 → Set company name, currency, license key
Step 5 → Click "Run Installation" — done in 30 seconds
```

---

## Requirements

| Software | Minimum Version | Check Command |
|----------|----------------|---------------|
| PHP | 8.3+ | `php -v` |
| MySQL | 8.0+ | `mysql --version` |
| Composer | 2.x | `composer -V` |
| Node.js | 20+ | `node -v` |
| npm | 10+ | `npm -v` |
| Redis | 7+ (optional) | `redis-server -v` |

**PHP Extensions needed:** pdo, pdo_mysql, bcmath, mbstring, openssl, gd, zip, sodium

---

## License Key

You need a GMLM Platform license key for the installer.
Contact: **support@globalmlmsoftware.com**