Initial commit: Chain 138 Explorer monorepo structure
This commit is contained in:
78
README.md
Normal file
78
README.md
Normal file
@@ -0,0 +1,78 @@
|
||||
# Chain 138 Explorer Monorepo
|
||||
|
||||
A comprehensive blockchain explorer for ChainID 138 with bridge monitoring and WETH utilities.
|
||||
|
||||
## 🏗️ 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
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone <repository-url>
|
||||
cd explorer-monorepo
|
||||
|
||||
# Or if used as submodule
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
### Deployment
|
||||
|
||||
```bash
|
||||
# Deploy to production
|
||||
./scripts/deploy.sh
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
See the `docs/` directory for detailed documentation:
|
||||
- API documentation
|
||||
- Deployment guides
|
||||
- Configuration references
|
||||
- Feature documentation
|
||||
|
||||
## 🔧 Development
|
||||
|
||||
### Local Development
|
||||
|
||||
```bash
|
||||
# Serve locally
|
||||
cd frontend/public
|
||||
python3 -m http.server 8000
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
# If using build tools
|
||||
npm run build
|
||||
```
|
||||
|
||||
## 📝 License
|
||||
|
||||
See LICENSE file for details.
|
||||
|
||||
Reference in New Issue
Block a user