b1415f15fc
- README: add Frontend section, deploy script, docs links, status - docs/README.md: new documentation overview (entry points, frontend, deployment) - docs/EXPLORER_API_ACCESS.md: reference deploy-frontend-to-vmid5000.sh for frontend-only deploy - docs/INDEX.md: add Frontend & Explorer section, fix Quick Start, Last Updated - README_DEPLOYMENT: add docs/README, EXPLORER_API_ACCESS, deploy script, deployment guide - frontend/FRONTEND_REVIEW.md: add post-review update (C1–L4 implemented) Co-authored-by: Cursor <cursoragent@cursor.com>
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
# SolaceScanScout Explorer - Tiered Architecture
|
||
|
||
## 🚀 Quick Start - Complete Deployment
|
||
|
||
**Execute this single command to complete all deployment steps:**
|
||
|
||
```bash
|
||
cd ~/projects/proxmox/explorer-monorepo
|
||
bash EXECUTE_DEPLOYMENT.sh
|
||
```
|
||
|
||
## What This Does
|
||
|
||
1. ✅ Tests database connection
|
||
2. ✅ Runs migration (if needed)
|
||
3. ✅ Stops existing server
|
||
4. ✅ Starts server with database
|
||
5. ✅ Tests all endpoints
|
||
6. ✅ Provides status summary
|
||
|
||
## Manual Execution
|
||
|
||
If the script doesn't work, see `START_HERE.md` for step-by-step manual commands.
|
||
|
||
## Frontend
|
||
|
||
- **Live SPA:** `frontend/public/index.html` — deployed to VMID 5000 at **https://explorer.d-bis.org**
|
||
- **Deploy frontend only:** `./scripts/deploy-frontend-to-vmid5000.sh` (from repo root; copies `index.html` to `/var/www/html/`)
|
||
- **Frontend review & tasks:** [frontend/FRONTEND_REVIEW.md](frontend/FRONTEND_REVIEW.md), [frontend/FRONTEND_TASKS_AND_REVIEW.md](frontend/FRONTEND_TASKS_AND_REVIEW.md)
|
||
- **React/Next.js app** in `frontend/src/` (dev/build only; not deployed)
|
||
|
||
## Documentation
|
||
|
||
- **`docs/README.md`** — Documentation overview and index
|
||
- **`docs/EXPLORER_API_ACCESS.md`** — API access, 502 fix, CSP, frontend deploy
|
||
- **`START_HERE.md`** — Quick start with all commands
|
||
- **`COMPLETE_DEPLOYMENT.md`** — Detailed deployment steps
|
||
- **`DEPLOYMENT_COMPLETE_FINAL.md`** — Final status report
|
||
- **`README_DEPLOYMENT.md`** — Deployment quick reference
|
||
- **`deployment/DEPLOYMENT_GUIDE.md`** — Full LXC/Nginx/Cloudflare deployment guide
|
||
- **`docs/INDEX.md`** — Bridge and operations doc index
|
||
|
||
## Architecture
|
||
|
||
- **Track 1 (Public):** RPC Gateway - No authentication required
|
||
- **Track 2 (Approved):** Indexed Explorer - Requires authentication
|
||
- **Track 3 (Analytics):** Analytics Dashboard - Requires Track 3+
|
||
- **Track 4 (Operator):** Operator Tools - Requires Track 4 + IP whitelist
|
||
|
||
## Configuration
|
||
|
||
- **Database User:** `explorer`
|
||
- **Database Password:** `L@ker$2010`
|
||
- **RPC URL:** `http://192.168.11.250:8545`
|
||
- **Chain ID:** `138`
|
||
- **Port:** `8080`
|
||
|
||
## Status
|
||
|
||
✅ All implementation complete
|
||
✅ All scripts ready
|
||
✅ All documentation complete
|
||
✅ Frontend task list complete (C1–L4: security, a11y, API modules, block card helper, deploy script)
|
||
|
||
**Ready for deployment!**
|