Files
proxmox/docs/11-references/README_EXPLORER_SUBMODULE.md
defiQUG cb47cce074 Complete markdown files cleanup and organization
- Organized 252 files across project
- Root directory: 187 → 2 files (98.9% reduction)
- Moved configuration guides to docs/04-configuration/
- Moved troubleshooting guides to docs/09-troubleshooting/
- Moved quick start guides to docs/01-getting-started/
- Moved reports to reports/ directory
- Archived temporary files
- Generated comprehensive reports and documentation
- Created maintenance scripts and guides

All files organized according to established standards.
2026-01-06 01:46:25 -08:00

2.1 KiB

Explorer Monorepo Submodule

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:

git submodule update --init --recursive

Updating the Explorer

To update the explorer to the latest version:

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:

    cd explorer-monorepo
    
  2. Make your changes

  3. Commit and push (if using remote repo):

    git add .
    git commit -m "Your change description"
    git push
    
  4. Update the parent project reference:

    cd ..
    git add explorer-monorepo
    git commit -m "Update explorer submodule reference"
    

Deploying Explorer

From the explorer monorepo directory:

cd explorer-monorepo
./scripts/deploy.sh

Or from the root:

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