You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- DEMO=true + DEMO_ADDR=sent1... boots a watch-only session on any
operator address. Bech32 validated at boot. POST/PUT/DELETE return
403 with a friendly "clone the repo" message so nothing can be
signed by accident.
- /api/wallet/status now exposes demo:true; UI shows a topbar banner
pointing visitors at the GitHub repo when running in demo.
- README: drop the npm-global install path (we are not publishing),
replace docker-compose .env clobber with cp .env.example, add
npx degit one-liner, and put a "just want to look around"
demo-mode quickstart at the top.
- engines.node >=20 in package.json so older Node fails fast.
- gitignore: privy-wallets.json, .servererr.txt, .serverlog*.txt,
social/ — runtime artifacts that should never be tracked.
Copy file name to clipboardExpand all lines: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,20 +47,31 @@ See [PLANS.md](./PLANS.md) for the full breakdown: plan lifecycle, plan-based vs
47
47
48
48
> **This tool operates on Sentinel mainnet. Every transaction costs real P2P tokens. There is no testnet mode.**
49
49
50
-
### Option A — npm (recommended, one-shot)
50
+
### Just want to look around?
51
+
52
+
Boot a read-only demo mounted on any operator address — no wallet, no tokens, no commitment. Every TX-broadcasting endpoint returns 403 so nothing can be signed by accident.
# → http://localhost:3003 with a demo banner across the top
57
60
```
58
61
59
-
### Option B — git clone (for contributors)
62
+
Pick any plan-creating operator address from a chain explorer, paste it into `DEMO_ADDR`, and the dashboard renders that operator's plans, nodes, and subscribers.
cp .env.example .env # then edit .env and paste your mnemonic
66
77
npm start
@@ -70,7 +81,7 @@ npm start
70
81
71
82
Open http://localhost:3003.
72
83
73
-
### Option C — Docker
84
+
### Run your own — Option B: Docker
74
85
75
86
```bash
76
87
# one-liner
@@ -83,13 +94,13 @@ docker run -d --name plan-manager \
83
94
sentinel-plan-manager
84
95
85
96
# or with compose (includes named volume + auto-restart)
86
-
echo"MNEMONIC=word1 word2 ... word24">.env
97
+
cp .env.example .env # then edit .env and paste your mnemonic
87
98
docker compose up -d
88
99
```
89
100
90
101
State (`.wallet.json`, `my-plans.json`, `nodes-cache.json`) lives in the `/data` volume so it survives container recreations. Leave `MNEMONIC` unset to create a wallet from the UI on first boot instead.
91
102
92
-
### Option D — Multi-user deploy (public domain)
103
+
### Option C — Multi-user deploy (public domain)
93
104
94
105
Want to deploy this to a domain and let anyone sign in with their own mnemonic? Set `MULTI_USER=true`:
<strong>Demo mode</strong> — read-only preview on a public operator. Clone the repo and set <code>MNEMONIC</code> in <code>.env</code> to run your own.
4833
+
</div>
4834
+
<aclass="demo-banner-cta" href="https://github.com/Sentinel-Bluebuilder/sentinel-plan-manager" target="_blank" rel="noopener">Get the source →</a>
4835
+
</div>
4804
4836
<divid="app">
4805
4837
<divclass="loading-state"><divclass="loading-spinner"></div><divclass="loading-text">Connecting to Sentinel network...</div></div>
0 commit comments