explorer-monorepo/docs/STRUCTURE.md

Monorepo Structure

Directory Overview

/frontend

Frontend application code.

• public/: Static HTML, CSS, JavaScript files served directly
  • index.html: Main explorer interface
• src/: Source files (if using build tools like webpack, vite, etc.)
• assets/: Images, fonts, and other static assets

/backend

Backend services (if needed for future enhancements).

• api/: API service code
• Currently empty - explorer uses Blockscout API directly

/scripts

Deployment and utility scripts.

• deploy.sh: Deploy explorer to production
• test.sh: Test explorer functionality

/docs

Documentation files.

• DEPLOYMENT.md: Deployment instructions
• STRUCTURE.md: This file
• Additional documentation as needed

/deployment

Deployment configurations and templates.

/config

Configuration files.

• deployment.json: Deployment settings for different environments

File Organization

explorer-monorepo/
├── frontend/
│   ├── public/
│   │   └── index.html          # Main explorer interface
│   ├── src/                    # Source files (if using build tools)
│   └── assets/                 # Static assets
├── backend/                    # Backend services (future)
├── scripts/
│   ├── deploy.sh               # Deployment script
│   └── test.sh                 # Testing script
├── docs/
│   ├── DEPLOYMENT.md           # Deployment guide
│   └── STRUCTURE.md            # This file
├── deployment/                 # Deployment configs
├── config/
│   └── deployment.json         # Environment configs
├── .gitignore                  # Git ignore rules
├── package.json                # Root package.json
└── README.md                   # Main README

Adding New Features

Frontend Changes

1. Edit frontend/public/index.html directly (current approach)
2. Or set up build tools in frontend/src/ for compiled output

Backend Changes

1. Add API services to backend/api/
2. Update deployment scripts if needed

Documentation

1. Add docs to docs/ directory
2. Update README.md as needed