Update directory structure: move example data to example/data

- 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 <noreply@anthropic.com>
This commit is contained in:
Louis King
2025-12-03 17:58:42 +00:00
parent 594ac14509
commit df6f6b779c
5 changed files with 18 additions and 7 deletions
+3 -1
View File
@@ -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
+3
View File
@@ -1,3 +1,6 @@
# Project
data/
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[codz]
+6 -3
View File
@@ -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
+5 -2
View File
@@ -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
+1 -1
View File
@@ -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')"]