@geibee/feedback-dom-capture

Feedback共通のDOMスクリーンショット取得provider


License
MIT
Install
npm install @geibee/feedback-dom-capture@1.0.0-rc.3

Documentation

Feedback System

既存のReact SPAへフィードバックUIを追加し、投稿・返信・スクリーンショットをRedmineへ保存します。 Feedback専用DBやobject storageは不要です。

ローカルで試す

Node.js 22.12以上25未満、npm、Docker Engine、Docker Compose v2が必要です。

npm ci
npm run feedback:redmine:local
  • Feedbackデモ: http://127.0.0.1:4173
  • Redmine: http://127.0.0.1:3001
# Redmineのログイン情報を表示
node packages/feedback-redmine-ops/dist/cli.js local credentials

# 終了
node packages/feedback-redmine-ops/dist/cli.js local down

この手順は評価専用Redmineを新規作成します。既存Redmineには実行しないでください。

既存のReactとRedmineへ導入する

1. Redmineを準備する

Feedback専用project、tracker、integration user、role、workflow、custom fieldを作成します。 Rails runnerを利用できる場合は、CLIで安全にplan/applyできます。

npx @geibee/feedback-redmine-ops@next provision extract \
  --output /secure/feedback-redmine/provision.rb

manifestと実行手順はFeedback Redmine導入・利用ガイドを参照してください。

2. gatewayを配備する

公開済みの標準イメージを使用します。ソースからのbuildは不要です。

docker pull ghcr.io/geibee/feedback-redmine-gateway:1.0.0-alpha.6

gatewayをSPAと同じoriginの/internal/feedback-redmine/v1へreverse proxyします。 8080番portを利用者へ直接公開せず、Redmine API keyと署名鍵はserver-side secretとして渡してください。 Compose例、profile、runtime config、環境変数はSPA導入ガイドにまとめています。

3. Reactへ組み込む

npm install @geibee/feedback-redmine-plugin@next

Host Adapterの最小例をアプリのrouterへ接続し、 plugin controllerをアプリケーションrootで一度作成します。Redmine URLやsecretをSPAへ含めないでください。

4. 接続を確認する

npx @geibee/feedback-redmine-ops@next doctor \
  --origin https://app.example.com \
  --profile inventory-production

最後にSPAから投稿し、Redmineでissue、返信、添付画像、説明欄の画像とリンクを確認すれば完了です。

詳細資料

License

MIT License