Skip to content

PROJECT_STRUCTURE.md

Latest commit

 

History

History
29 lines (25 loc) · 1.19 KB

PROJECT_STRUCTURE.md

File metadata and controls

29 lines (25 loc) · 1.19 KB

Project Structure

RelayMesh follows a standard single-module Maven layout:

relaymesh/
  .github/workflows/        # CI workflows
  docs/                     # architecture docs, rollout plans, reading guides
    guides/                 # focused reader/operator guides
  examples/                 # sample workflow inputs
  scripts/                  # smoke, benchmark, chaos scripts
  src/main/java/            # runtime implementation
  src/main/resources/       # embedded web/static assets
    web/                    # control-room HTML and related web resources
  src/test/java/            # unit/integration tests
  tmp/                      # local runtime outputs (ignored)
  pom.xml                   # build definition
  README.md                 # project overview
  CONTRIBUTING.md           # contributor guide
  CODE_OF_CONDUCT.md        # community collaboration baseline
  SECURITY.md               # security disclosure policy

Important Rules

  • Do not commit runtime output directories.
  • Use tmp/... as default root in scripts and local runs.
  • Keep sample JSON under examples/workflows/.
  • Keep navigation docs up to date: docs/README.md and docs/guides/READING_GUIDE.md.