KNEL/TSYSDevStack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add stack readmes and overview

Browse Source
This commit is contained in:
Charles N Wyble - admin
2025-10-29 06:02:44 -05:00
parent 7061fbb2a9
commit 04fc08c655
4 changed files with 139 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
SupportStack/README.md Normal file
View File

@@ -0,0 +1,37 @@
# 🛟 SupportStack
The SupportStack delivers a curated demo environment for customer support tooling. It bundles Dockerized services, environment settings, automation scripts, and a growing library of collaboration notes.
---
## Stack Snapshot
| Component | Purpose | Path |
|-----------|---------|------|
| Control Script | Orchestrates start/stop/update/test flows for the demo stack. | [`output/code/TSYSDevStack-SupportStack-Demo-Control.sh`](output/code/TSYSDevStack-SupportStack-Demo-Control.sh) |
| Environment Settings | Centralized `.env` style configuration consumed by scripts and compose files. | [`output/TSYSDevStack-SupportStack-Demo-Settings`](output/TSYSDevStack-SupportStack-Demo-Settings) |
| Docker Compose Bundles | Service definitions for docker-socket-proxy, homepage, WakaAPI, and MailHog. | [`output/docker-compose/`](output/docker-compose) |
| Service Config | Homepage/WakaAPI configuration mounted into containers. | [`output/config/`](output/config) |
| Tests | Shell-based smoke, unit, and discovery tests for stack services. | [`output/tests/`](output/tests) |
| Docs & Vendor Research | Reference material and curated vendor lists. | [`output/docs/`](output/docs) |
| Collaboration Notes | Product direction, prompts, and status updates. | [`collab/`](collab) |
---
## Getting Started
1. Export or edit variables in `output/TSYSDevStack-SupportStack-Demo-Settings`.
2. Use the control script to manage the stack:
```bash
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh start
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh test
./output/code/TSYSDevStack-SupportStack-Demo-Control.sh stop
```
3. Review `output/tests/` for additional validation scripts.
> ℹ️ The stack expects Docker access and creates the shared network `tsysdevstack-supportstack-demo-network` if it does not exist.
---
## Collaboration Notes
- Keep demo automation in `output/` and exploratory material in `collab/`.
- When adding a new service, update both the compose files and the test suite to maintain coverage.
- Synchronize documentation changes with any updates to automation or configuration—future contributors rely on the README table as the source of truth.