Skip to content

Commit df6f6b7

Browse files
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>
1 parent 594ac14 commit df6f6b7

5 files changed

Lines changed: 18 additions & 7 deletions

File tree

.env.example

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@ NETWORK_CONTACT_EMAIL=
7373
NETWORK_CONTACT_DISCORD=
7474

7575
# Path to members JSON file (mounted into container)
76-
MEMBERS_FILE_PATH=./data/members.json
76+
# For production: use ./data/members.json
77+
# For testing with example data: use ./example/data/members.json
78+
MEMBERS_FILE_PATH=./example/data/members.json
7779

7880
# ===================
7981
# Webhook Settings

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Project
2+
data/
3+
14
# Byte-compiled / optimized / DLL files
25
__pycache__/
36
*.py[codz]

AGENTS.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,13 @@ meshcore-hub/
276276
│ └── versions/
277277
├── etc/
278278
│ └── mosquitto.conf # MQTT broker configuration
279-
├── data/
280-
│ └── members.json # Network members data
279+
├── example/
280+
│ └── data/
281+
│ └── members.json # Example network members data
282+
├── data/ # Runtime data (gitignored)
281283
├── Dockerfile # Docker build configuration
282-
└── docker-compose.yml # Docker Compose services
284+
├── docker-compose.yml # Docker Compose services (gitignored)
285+
└── docker-compose.yml.example # Docker Compose template
283286
```
284287

285288
## MQTT Topic Structure

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,9 +359,12 @@ meshcore-hub/
359359
├── tests/ # Test suite
360360
├── alembic/ # Database migrations
361361
├── etc/ # Configuration files (mosquitto.conf)
362-
├── data/ # Data files (members.json)
362+
├── example/ # Example files for testing
363+
│ └── data/ # Example data files (members.json)
364+
├── data/ # Runtime data (gitignored)
363365
├── Dockerfile # Docker build configuration
364-
├── docker-compose.yml # Docker Compose services
366+
├── docker-compose.yml # Docker Compose services (gitignored)
367+
├── docker-compose.yml.example # Docker Compose template
365368
├── PROMPT.md # Project specification
366369
├── SCHEMAS.md # Event schema documentation
367370
├── PLAN.md # Implementation plan

docker-compose.yml.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ services:
265265
- NETWORK_CONTACT_DISCORD=${NETWORK_CONTACT_DISCORD:-}
266266
- MEMBERS_FILE=${MEMBERS_FILE:-}
267267
volumes:
268-
- ${MEMBERS_FILE_PATH:-./data/members.json}:/app/members.json:ro
268+
- ${MEMBERS_FILE_PATH:-./example/data/members.json}:/app/members.json:ro
269269
command: ["web"]
270270
healthcheck:
271271
test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8080/health')"]

0 commit comments

Comments
 (0)