proxmox/docs/11-references/README_EXPLORER_SUBMODULE.md

# Explorer Monorepo Submodule

**Last Updated:** 2026-01-31  
**Document Version:** 1.0  
**Status:** Active Documentation

---

The Chain 138 Explorer is now organized as a monorepo and added as a git submodule.

## 📁 Location

The explorer monorepo is located at: `explorer-monorepo/`

## 🚀 Usage

### Initial Setup

If cloning the main project fresh, initialize the submodule:

```bash
git submodule update --init --recursive
```

### Updating the Explorer

To update the explorer to the latest version:

```bash
cd explorer-monorepo
git pull origin main  # or master
cd ..
git add explorer-monorepo
git commit -m "Update explorer submodule"
```

### Making Changes to Explorer

1. Navigate to the submodule:
   ```bash
   cd explorer-monorepo
   ```

2. Make your changes
3. Commit and push (if using remote repo):
   ```bash
   git add .
   git commit -m "Your change description"
   git push
   ```

4. Update the parent project reference:
   ```bash
   cd ..
   git add explorer-monorepo
   git commit -m "Update explorer submodule reference"
   ```

### Deploying Explorer

From the explorer monorepo directory:

```bash
cd explorer-monorepo
./scripts/deploy.sh
```

Or from the root:

```bash
cd explorer-monorepo && ./scripts/deploy.sh
```

## 📚 Documentation

See `explorer-monorepo/README.md` and `explorer-monorepo/docs/` for detailed documentation.

## 🔗 Structure

```
proxmox/
├── explorer-monorepo/          # Explorer submodule
│   ├── frontend/               # Frontend code
│   ├── scripts/                # Deployment scripts
│   ├── docs/                   # Documentation
│   └── ...
├── scripts/                    # Main project scripts
├── docs/                       # Main project docs
└── ...
```

## ⚠️ Important Notes

1. **Submodule is Local**: Currently, the submodule points to a local path. To use with a remote repository:
   - Create a remote repository for the explorer
   - Update `.gitmodules` with the remote URL
   - Push the explorer repo to remote

2. **Deployment**: The explorer is deployed to `192.168.11.140:/var/www/html/`

3. **Backups**: The deploy script creates automatic backups before deployment