d-bis/explorer-monorepo
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: update all documentation and add overview

Browse Source 
- 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>
This commit is contained in:
defiQUG
2026-02-10 19:02:19 -08:00
parent f774f8f644
commit 2d43dcd2d4
6 changed files with 95 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/EXPLORER_API_ACCESS.md
View File

@@ -22,7 +22,7 @@ The ethers.js v5 UMD bundle from the CDN uses `eval`/`new Function()` for ABI de
If the browser still reports **“Content Security Policy blocks the use of 'eval'”** or **script-src blocked**:
1. **Redeploy the frontend** so the live site gets the current `index.html` (with the meta CSP including `'unsafe-eval'`). For VMID 5000, run `scripts/complete-explorer-api-access.sh` or copy `frontend/public/index.html` to the server’s web root (e.g. `/var/www/html/`).
1. **Redeploy the frontend** so the live site gets the current `index.html` (with the meta CSP including `'unsafe-eval'`). For VMID 5000, run **`scripts/deploy-frontend-to-vmid5000.sh`** (frontend-only) or **`scripts/complete-explorer-api-access.sh`** (full). Alternatively, copy `frontend/public/index.html` to the server’s web root (e.g. `/var/www/html/`).
2. **Check what CSP the browser sees** – DevTools → Network → select the document request (the HTML page) → Headers → **Response Headers** → `Content-Security-Policy`. It should contain `'unsafe-eval'` in `script-src`. If the response has a CSP header **without** `'unsafe-eval'`, that header is coming from your server (nginx or app) or from a proxy (e.g. Cloudflare). Update the config that serves the explorer so its CSP includes `'unsafe-eval'`, then reload (hard refresh or incognito).
3. **If you use Cloudflare** – In the dashboard, check Transform Rules, Page Rules, or Security → Settings for any **Content-Security-Policy** (or similar) header that might override the origin. Ensure that header’s `script-src` includes `'unsafe-eval'`, or remove the override so the origin CSP is used.

19
docs/INDEX.md
View File

@@ -1,13 +1,24 @@
# Documentation Index
**Complete Guide to All Bridge System Documentation**
**Complete Guide to Explorer Monorepo Documentation**
---
## 🚀 Quick Start
1. **[Complete Setup Guide](./COMPLETE_SETUP_GUIDE.md)** - Start here for complete setup
2. **[README Bridge](../README_BRIDGE.md)** - Quick reference at project root
1. **[../README.md](../README.md)** - Project overview, quick start, frontend deploy
2. **[EXPLORER_API_ACCESS.md](./EXPLORER_API_ACCESS.md)** - API access, 502 fix, CSP, frontend deploy
3. **[README Bridge](../README_BRIDGE.md)** - Quick reference at project root
4. **[Complete Setup Guide](./COMPLETE_SETUP_GUIDE.md)** - Complete setup (if present)
---
## Frontend & Explorer
- **[../frontend/FRONTEND_REVIEW.md](../frontend/FRONTEND_REVIEW.md)** - Frontend code review (SPA + React)
- **[../frontend/FRONTEND_TASKS_AND_REVIEW.md](../frontend/FRONTEND_TASKS_AND_REVIEW.md)** - Task list (C1–L4) and detail review
- **Deploy frontend:** From repo root run `./scripts/deploy-frontend-to-vmid5000.sh`
- **Full fix (API + frontend):** `./scripts/complete-explorer-api-access.sh`
---
@@ -186,5 +197,5 @@
---
**Last Updated**: $(date)
**Last Updated:** 2025-02-09

56
docs/README.md Normal file
View File

@@ -0,0 +1,56 @@
# Explorer Monorepo – Documentation
Overview of documentation for the ChainID 138 Explorer (SolaceScanScout).
---
## Entry points
| Doc | Description |
|-----|-------------|
| **[INDEX.md](./INDEX.md)** | Full documentation index (bridge, setup, verification, operations) |
| **[EXPLORER_API_ACCESS.md](./EXPLORER_API_ACCESS.md)** | API access, 502 fix, CSP, frontend deploy for https://explorer.d-bis.org |
| **[../README.md](../README.md)** | Project README: quick start, frontend, architecture, config |
---
## Frontend
| Doc | Description |
|-----|-------------|
| **[../frontend/FRONTEND_REVIEW.md](../frontend/FRONTEND_REVIEW.md)** | Frontend code review (SPA + React) |
| **[../frontend/FRONTEND_TASKS_AND_REVIEW.md](../frontend/FRONTEND_TASKS_AND_REVIEW.md)** | Task list C1–L4 and detail review |
**Deploy the live SPA (VMID 5000):**
```bash
./scripts/deploy-frontend-to-vmid5000.sh
```
**Full fix (Blockscout + nginx + frontend):**
```bash
./scripts/complete-explorer-api-access.sh
```
---
## Deployment
| Doc | Description |
|-----|-------------|
| **[../README_DEPLOYMENT.md](../README_DEPLOYMENT.md)** | Deployment quick reference |
| **[../deployment/DEPLOYMENT_GUIDE.md](../deployment/DEPLOYMENT_GUIDE.md)** | Full LXC + Nginx + Cloudflare deployment guide |
| **[../QUICKSTART.md](../QUICKSTART.md)** | Quick start (deps, infra, dev services) |
---
## Other
- **Bridge / WETH:** See [INDEX.md](./INDEX.md) for bridge setup, verification, and operations.
- **Specs:** [specs/](./specs/) for infrastructure and multichain specs.
- **CCIP, Blockscout, etc.:** See files in this directory and the repo root.
---
*Last updated: 2025-02-09*