Initial scaffold: CLAUDE.md modules, directory structure, .gitignore
This commit is contained in:
38
README.md
Normal file
38
README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Ignition + Docker Development Framework
|
||||
|
||||
Reusable scaffold for Ignition SCADA + Docker projects, designed to work with Claude Code as the AI development assistant.
|
||||
|
||||
## First Consumer
|
||||
|
||||
**PLC I/O Testing Platform** — automated PLC I/O validation using JSON-defined test scenarios.
|
||||
|
||||
## Stack
|
||||
|
||||
- Ignition 8.3 (Perspective, WebDev, OPC-UA, Git-native project storage)
|
||||
- Docker Compose on Ubuntu 24
|
||||
- Rockwell Allen-Bradley ControlLogix/CompactLogix
|
||||
- PostgreSQL 16
|
||||
- Traefik v3 (optional reverse proxy)
|
||||
- Gitea for source control
|
||||
|
||||
## Getting Started
|
||||
|
||||
See [CLAUDE.md](CLAUDE.md) for project directives, canonical patterns, and directory layout.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
├── CLAUDE.md ← root directives (Claude Code reads this automatically)
|
||||
├── docker/ ← Docker Compose stack and configs
|
||||
├── ignition/ ← Ignition project (mounted into container)
|
||||
├── testing/ ← test scenarios, runner, results
|
||||
├── webdev/ ← WebDev API endpoint contracts
|
||||
├── tools/ ← Python 3.10+ external utilities
|
||||
└── docs/ ← project documentation
|
||||
```
|
||||
|
||||
Each subdirectory contains its own `CLAUDE.md` with domain-specific rules.
|
||||
|
||||
## License
|
||||
|
||||
Internal use only.
|
||||
Reference in New Issue
Block a user