d-bis/explorer-monorepo
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bdae5a9f6e8e2a357a4f33f5159045e35ae31ec3
explorer-monorepo/docs/README.md

65 lines
2.1 KiB
Markdown
Raw Normal View History

Docs: update all documentation and add overview - 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>
2026-02-10 19:02:19 -08:00
# 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 |
|-----|-------------|
feat: explorer API, wallet, CCIP scripts, and config refresh - Backend REST/gateway/track routes, analytics, Blockscout proxy paths. - Frontend wallet and liquidity surfaces; MetaMask token list alignment. - Deployment docs, verification scripts, address inventory updates. Check: go build ./... under backend/ (pass). Made-with: Cursor
2026-04-07 23:22:12 -07:00
| **[../frontend/FRONTEND_REVIEW.md](../frontend/FRONTEND_REVIEW.md)** | Frontend code review (Next app + legacy SPA) |
Docs: update all documentation and add overview - 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>
2026-02-10 19:02:19 -08:00
| **[../frontend/FRONTEND_TASKS_AND_REVIEW.md](../frontend/FRONTEND_TASKS_AND_REVIEW.md)** | Task list C1–L4 and detail review |
feat: explorer API, wallet, CCIP scripts, and config refresh - Backend REST/gateway/track routes, analytics, Blockscout proxy paths. - Frontend wallet and liquidity surfaces; MetaMask token list alignment. - Deployment docs, verification scripts, address inventory updates. Check: go build ./... under backend/ (pass). Made-with: Cursor
2026-04-07 23:22:12 -07:00
**Deploy the current Next standalone frontend (VMID 5000):**
```bash
./scripts/deploy-next-frontend-to-vmid5000.sh
```
Nginx should preserve `/api`, `/api/config/*`, `/explorer-api/*`, `/token-aggregation/api/v1/*`, `/snap/`, and `/health`, then proxy `/` and `/_next/` using [deployment/common/nginx-next-frontend-proxy.conf](/home/intlc/projects/proxmox/explorer-monorepo/deployment/common/nginx-next-frontend-proxy.conf).
**Legacy static SPA deploy (fallback only):**
Docs: update all documentation and add overview - 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>
2026-02-10 19:02:19 -08:00
```bash
./scripts/deploy-frontend-to-vmid5000.sh
```
feat: explorer API, wallet, CCIP scripts, and config refresh - Backend REST/gateway/track routes, analytics, Blockscout proxy paths. - Frontend wallet and liquidity surfaces; MetaMask token list alignment. - Deployment docs, verification scripts, address inventory updates. Check: go build ./... under backend/ (pass). Made-with: Cursor
2026-04-07 23:22:12 -07:00
**Full explorer/API fix (Blockscout + nginx + frontend):**
Docs: update all documentation and add overview - 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>
2026-02-10 19:02:19 -08:00
```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*
Reference in New Issue Copy Permalink