Skip to content

Commit 05a970a

Browse files
committed
docs: add pipe console GitHub Pages
1 parent c5dd384 commit 05a970a

File tree

6 files changed

+1021
-0
lines changed

6 files changed

+1021
-0
lines changed

.github/workflows/pages.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy Pipe Console
2+
3+
on:
4+
push:
5+
branches: ["main", "master"]
6+
paths:
7+
- "docs/**"
8+
- ".github/workflows/pages.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: true
19+
20+
jobs:
21+
deploy:
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
30+
- name: Setup Pages
31+
uses: actions/configure-pages@v5
32+
33+
- name: Upload Pages Artifact
34+
uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: docs
37+
38+
- name: Deploy to GitHub Pages
39+
id: deployment
40+
uses: actions/deploy-pages@v4

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,6 +585,29 @@ Run an interactive browser demo (click link -> `402` -> sign -> unlock):
585585
npm run demo:x402-browser
586586
```
587587

588+
## Pipe Console (GitHub Pages)
589+
590+
This repo now includes a static pipe interaction page at `docs/`:
591+
592+
- `docs/index.html`
593+
- `docs/app.js`
594+
- `docs/styles.css`
595+
596+
It includes forms/buttons for:
597+
598+
1. wallet connect
599+
2. read-only `get-pipe`
600+
3. `fund-pipe` (open pipe)
601+
4. `force-cancel`
602+
5. structured transfer message signing + payload JSON builder
603+
604+
To publish with GitHub Pages (no build step):
605+
606+
1. go to repository Settings -> Pages
607+
2. Source: GitHub Actions
608+
3. push changes to `docs/` on `main` (or run `Deploy Pipe Console` manually)
609+
4. wait for the `Deploy Pipe Console` workflow to publish
610+
588611
Browser demo flow:
589612

590613
1. open the printed local URL (gateway front door)

docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

0 commit comments

Comments
 (0)