Add full monorepo: virtual-banker, backend, frontend, docs, scripts, deployment
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
97
README.md
97
README.md
@@ -1,78 +1,53 @@
|
||||
# Chain 138 Explorer Monorepo
|
||||
# SolaceScanScout Explorer - Tiered Architecture
|
||||
|
||||
A comprehensive blockchain explorer for ChainID 138 with bridge monitoring and WETH utilities.
|
||||
## 🚀 Quick Start - Complete Deployment
|
||||
|
||||
## 🏗️ Monorepo Structure
|
||||
|
||||
```
|
||||
explorer-monorepo/
|
||||
├── frontend/ # Frontend application
|
||||
│ ├── src/ # Source files (if using build tools)
|
||||
│ ├── assets/ # Static assets (images, fonts, etc.)
|
||||
│ └── public/ # Public HTML/CSS/JS files
|
||||
├── backend/ # Backend services (if needed)
|
||||
│ └── api/ # API services
|
||||
├── scripts/ # Deployment and utility scripts
|
||||
├── docs/ # Documentation
|
||||
├── deployment/ # Deployment configurations
|
||||
├── config/ # Configuration files
|
||||
└── package.json # Root package.json for monorepo
|
||||
```
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- **Block Explorer**: Browse blocks, transactions, and addresses
|
||||
- **Bridge Monitoring**: Monitor CCIP bridge contracts and cross-chain activity
|
||||
- **WETH Utilities**: Wrap/unwrap ETH using WETH9 and WETH10 contracts
|
||||
- **MetaMask Integration**: Full wallet connectivity and transaction signing
|
||||
- **Real-time Updates**: Live network statistics and data
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Installation
|
||||
**Execute this single command to complete all deployment steps:**
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone <repository-url>
|
||||
cd explorer-monorepo
|
||||
|
||||
# Or if used as submodule
|
||||
git submodule update --init --recursive
|
||||
cd ~/projects/proxmox/explorer-monorepo
|
||||
bash EXECUTE_DEPLOYMENT.sh
|
||||
```
|
||||
|
||||
### Deployment
|
||||
## What This Does
|
||||
|
||||
```bash
|
||||
# Deploy to production
|
||||
./scripts/deploy.sh
|
||||
```
|
||||
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
|
||||
|
||||
## 📚 Documentation
|
||||
## Manual Execution
|
||||
|
||||
See the `docs/` directory for detailed documentation:
|
||||
- API documentation
|
||||
- Deployment guides
|
||||
- Configuration references
|
||||
- Feature documentation
|
||||
If the script doesn't work, see `START_HERE.md` for step-by-step manual commands.
|
||||
|
||||
## 🔧 Development
|
||||
## Documentation
|
||||
|
||||
### Local Development
|
||||
- **`START_HERE.md`** - Quick start guide with all commands
|
||||
- **`COMPLETE_DEPLOYMENT.md`** - Detailed deployment steps
|
||||
- **`DEPLOYMENT_COMPLETE_FINAL.md`** - Final status report
|
||||
- **`docs/DATABASE_CONNECTION_GUIDE.md`** - Database connection details
|
||||
|
||||
```bash
|
||||
# Serve locally
|
||||
cd frontend/public
|
||||
python3 -m http.server 8000
|
||||
```
|
||||
## Architecture
|
||||
|
||||
### Build
|
||||
- **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
|
||||
|
||||
```bash
|
||||
# If using build tools
|
||||
npm run build
|
||||
```
|
||||
## Configuration
|
||||
|
||||
## 📝 License
|
||||
- **Database User:** `explorer`
|
||||
- **Database Password:** `***REDACTED-LEGACY-PW***`
|
||||
- **RPC URL:** `http://192.168.11.250:8545`
|
||||
- **Chain ID:** `138`
|
||||
- **Port:** `8080`
|
||||
|
||||
See LICENSE file for details.
|
||||
## Status
|
||||
|
||||
✅ All implementation complete
|
||||
✅ All scripts ready
|
||||
✅ All documentation complete
|
||||
|
||||
**Ready for deployment!**
|
||||
|
||||
Reference in New Issue
Block a user