feedback-kit-skills 1.0.21 → 1.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# FeedbackKit
|
|
2
2
|
|
|
3
|
+
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/testflight-portal.yml)
|
|
3
4
|
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/testflight.yml)
|
|
4
5
|
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/release-macos-demo.yml)
|
|
5
6
|
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/publish-cli.yml)
|
|
6
7
|
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/publish-skills.yml)
|
|
7
|
-
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/deploy-docs.yml)
|
|
8
9
|
[](https://github.com/tianhaoz95/feedback-kit/actions/workflows/deploy-functions.yml)
|
|
9
10
|
|
|
10
11
|
An iOS + macOS + watchOS SDK for capturing in-app user feedback (screenshot +
|
|
@@ -12,6 +13,9 @@ annotations + description + device/app/screen info on iOS/macOS; text +
|
|
|
12
13
|
context only on watchOS), plus an optional Supabase-backed dashboard for
|
|
13
14
|
collecting it and turning it into prompts for a coding agent.
|
|
14
15
|
|
|
16
|
+
> 📖 **Developer Documentation & Contributor Guide**: [https://tianhaoz95.github.io/feedback-kit/](https://tianhaoz95.github.io/feedback-kit/)
|
|
17
|
+
> 🚀 **Live Web Dashboard**: [https://feedback-kit.hejitech.workers.dev](https://feedback-kit.hejitech.workers.dev)
|
|
18
|
+
|
|
15
19
|
See [DESIGN.md](DESIGN.md) for how it's put together and why.
|
|
16
20
|
|
|
17
21
|
## Quickstart
|
|
@@ -169,28 +173,18 @@ You can also install directly using the GitHub repository shorthand:
|
|
|
169
173
|
npx skills add tianhaoz95/feedback-kit --skill setup-ios-sdk --yes
|
|
170
174
|
```
|
|
171
175
|
|
|
172
|
-
##
|
|
176
|
+
## Web Dashboard & Cloudflare Deployment
|
|
177
|
+
|
|
178
|
+
The hosted web dashboard is deployed on **Cloudflare Workers Static Assets** at [`https://feedback-kit.hejitech.workers.dev`](https://feedback-kit.hejitech.workers.dev) via Git integration (see `wrangler.jsonc`).
|
|
173
179
|
|
|
174
|
-
|
|
175
|
-
Pages via GitHub Actions (`actions/deploy-pages` — no `gh-pages` branch)
|
|
176
|
-
on every push to `main` that touches `web/`. One-time setup:
|
|
180
|
+
## Developer Documentation on GitHub Pages
|
|
177
181
|
|
|
178
|
-
|
|
179
|
-
from a branch").
|
|
180
|
-
2. **Settings → Secrets and variables → Actions → Variables**, add:
|
|
181
|
-
- `VITE_SUPABASE_URL`
|
|
182
|
-
- `VITE_SUPABASE_ANON_KEY`
|
|
182
|
+
The contributor developer documentation is hosted on GitHub Pages at [`https://tianhaoz95.github.io/feedback-kit/`](https://tianhaoz95.github.io/feedback-kit/).
|
|
183
183
|
|
|
184
|
-
|
|
185
|
-
client bundle, so repo **variables** (not secrets) are the right place for
|
|
186
|
-
them, same as `web/.env.local`.
|
|
184
|
+
`.github/workflows/deploy-docs.yml` builds `docs/` (powered by VitePress) and deploys it to GitHub Pages via GitHub Actions (`actions/deploy-pages`) on every push to `main` that touches `docs/**`. One-time setup:
|
|
187
185
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
`web/vite.config.ts` and `basename` in `web/src/main.tsx` if that ever
|
|
191
|
-
changes. It also copies `dist/index.html` to `dist/404.html` after building
|
|
192
|
-
so direct loads/refreshes of deep links (e.g. `/projects/abc`) still resolve
|
|
193
|
-
client-side, since GitHub Pages has no server-side rewrites.
|
|
186
|
+
1. **Settings → Pages → Source: "GitHub Actions"** on the repository.
|
|
187
|
+
2. The workflow automatically builds the documentation and deploys the static output to GitHub Pages.
|
|
194
188
|
|
|
195
189
|
## Deploying Supabase (migrations + edge functions)
|
|
196
190
|
|
|
@@ -314,10 +308,11 @@ API key with access to the team, the same one works for both.
|
|
|
314
308
|
|
|
315
309
|
| Path | What |
|
|
316
310
|
|---|---|
|
|
317
|
-
| `Sources/FeedbackKit/` | The iOS SDK (Swift Package) |
|
|
311
|
+
| `Sources/FeedbackKit/` | The iOS + macOS + watchOS SDK (Swift Package) |
|
|
318
312
|
| `Tests/FeedbackKitTests/` | SDK unit tests |
|
|
319
313
|
| `DemoApp/` | Sample apps exercising the SDK on iOS, macOS, and watchOS (one XcodeGen project, three targets) |
|
|
320
|
-
| `web/` | Static SPA dashboard (Vite + React),
|
|
314
|
+
| `web/` | Static SPA dashboard (Vite + React), deployed to Cloudflare Workers Static Assets |
|
|
315
|
+
| `docs/` | Contributor developer documentation (VitePress), deployed to GitHub Pages |
|
|
321
316
|
| `supabase/` | Postgres migrations, storage policies, the ingestion Edge Function, billing (Stripe) Edge Functions |
|
|
322
317
|
| `cli/` | `feedbackkit` CLI + MCP server (Node/TypeScript) |
|
|
323
318
|
| `skills/` | Agent Skills catalog (`vercel-labs/skills`) for automated setup via AI coding agents |
|