docs: establish deployment repository rules
This commit is contained in:
26
README.md
Normal file
26
README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# ZarinPal Merchant Analytics — Deployment
|
||||
|
||||
This repository is the operational control plane for the hackathon project. It will own Docker Compose, Nginx, environment templates, deployment automation, backup/restore scripts, and cross-repository release orchestration. Product code belongs in the backend and frontend repositories.
|
||||
|
||||
Current state: specification and repository bootstrap only. No application or deployment implementation has been approved yet.
|
||||
|
||||
## Repository topology
|
||||
|
||||
```text
|
||||
zarinpal-analytics-deployment/ # this repository
|
||||
├── backend/ # ignored checkout of zarinpal-analytics-backend
|
||||
├── frontend/ # ignored checkout of zarinpal-analytics-frontend
|
||||
├── docs/
|
||||
└── (deployment assets after specification approval)
|
||||
```
|
||||
|
||||
The intended production hostname is `zarinpal.amiirkhl.ir`. The deployment shape will follow the proven Qlockify structure while being reviewed and hardened for this service; it is not a byte-for-byte copy.
|
||||
|
||||
## Documentation workflow
|
||||
|
||||
- `CAPABILITY-MAP.md` is the approved Phase 0 decomposition.
|
||||
- Each capability receives a spec before implementation.
|
||||
- Surprising or hard-to-reverse decisions receive an ADR in `docs/decisions/`.
|
||||
- Raw datasets and database state are never committed.
|
||||
- Every material change is a small Conventional Commit.
|
||||
|
||||
Reference in New Issue
Block a user