From df6f6b779c0fed9d51a043f5de090d3fc698609b Mon Sep 17 00:00:00 2001 From: Louis King Date: Wed, 3 Dec 2025 17:58:42 +0000 Subject: [PATCH] Update directory structure: move example data to example/data MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Update docker-compose.yml.example to use example/data paths - Update .env.example with example/data paths and comments - Update README.md and AGENTS.md project structure documentation - Add data/ to .gitignore (runtime data directory) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- .env.example | 4 +++- .gitignore | 3 +++ AGENTS.md | 9 ++++++--- README.md | 7 +++++-- docker-compose.yml.example | 2 +- 5 files changed, 18 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index 1c3cb95..5749460 100644 --- a/.env.example +++ b/.env.example @@ -73,7 +73,9 @@ NETWORK_CONTACT_EMAIL= NETWORK_CONTACT_DISCORD= # Path to members JSON file (mounted into container) -MEMBERS_FILE_PATH=./data/members.json +# For production: use ./data/members.json +# For testing with example data: use ./example/data/members.json +MEMBERS_FILE_PATH=./example/data/members.json # =================== # Webhook Settings diff --git a/.gitignore b/.gitignore index d235f99..8ed4059 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Project +data/ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[codz] diff --git a/AGENTS.md b/AGENTS.md index 1b42559..c4df373 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -276,10 +276,13 @@ meshcore-hub/ │ └── versions/ ├── etc/ │ └── mosquitto.conf # MQTT broker configuration -├── data/ -│ └── members.json # Network members data +├── example/ +│ └── data/ +│ └── members.json # Example network members data +├── data/ # Runtime data (gitignored) ├── Dockerfile # Docker build configuration -└── docker-compose.yml # Docker Compose services +├── docker-compose.yml # Docker Compose services (gitignored) +└── docker-compose.yml.example # Docker Compose template ``` ## MQTT Topic Structure diff --git a/README.md b/README.md index 60022a6..d6f3d29 100644 --- a/README.md +++ b/README.md @@ -359,9 +359,12 @@ meshcore-hub/ ├── tests/ # Test suite ├── alembic/ # Database migrations ├── etc/ # Configuration files (mosquitto.conf) -├── data/ # Data files (members.json) +├── example/ # Example files for testing +│ └── data/ # Example data files (members.json) +├── data/ # Runtime data (gitignored) ├── Dockerfile # Docker build configuration -├── docker-compose.yml # Docker Compose services +├── docker-compose.yml # Docker Compose services (gitignored) +├── docker-compose.yml.example # Docker Compose template ├── PROMPT.md # Project specification ├── SCHEMAS.md # Event schema documentation ├── PLAN.md # Implementation plan diff --git a/docker-compose.yml.example b/docker-compose.yml.example index aa4ead8..fed1324 100644 --- a/docker-compose.yml.example +++ b/docker-compose.yml.example @@ -265,7 +265,7 @@ services: - NETWORK_CONTACT_DISCORD=${NETWORK_CONTACT_DISCORD:-} - MEMBERS_FILE=${MEMBERS_FILE:-} volumes: - - ${MEMBERS_FILE_PATH:-./data/members.json}:/app/members.json:ro + - ${MEMBERS_FILE_PATH:-./example/data/members.json}:/app/members.json:ro command: ["web"] healthcheck: test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8080/health')"]