Add step-by-step instructions to README.md
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 40/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- node.js, react, typescript
調査の方向性
まず README.md を開き、private-data-transfer-cli と private-data-transfer-ui のサンプルについて既存の案内を確認します。記載されている Node.js のバージョン確認、npm install の手順、npm run start コマンド、UI のポート 3000 に関する詳細を使って、手順に沿ったセットアップフローを構成します。Node.js 開発者でない人が両方のサンプルを起動し、それぞれが何を実演するものなのか理解できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
I was working on the getting started docs in FireFly, and I wanted to defer all the samples related docs to point at the README. md in this repo.
However, unless you're a Node.js developer I don't think currently there's quite enough info in this repo to get people started.
Here's what was in the docs on the FireFly side, which I'm pulling out.
I think even this is a little bit less than the step by step someone might need.
... raising a separate issue for a discussion on getting a Docker built samples gallery
This repository contains two straightforward, turnkey samples. A simple CLI-based flow, and a more robust flow with a React frontend, with the option for customized recipients and messaging strings.
- FireFly Samples Repo
- clone this ^^
- Node.js - latest version recommended (v14.17.0)
node -vto check your current version
- Install the node dependencies in each folder: (
/firefly-samples/private-data-transfer-cli&/firefly-samples/private-data-transfer-ui) withnpm install. - The following command:
npm run startwill kick either program. Run the command separately from the root of each project.- The "Private-Data-Transfer-Cli" will self execute with a message broadcast and acknowledgement of message receipt.
- The "Private-Data-Transfer-UI" will serve locally on port 3000. You can toggle amongst your FireFly memberships to see different message/transaction details - timestamp, sender and inputs.
- 主要言語
- TypeScript
- スター
- 25
- フォーク
- 24
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
hyperledger-firefly/samples のほかの issue
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
hyperledger-firefly/samples#20 · リアクション 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
hyperledger-firefly/samples#36 · リアクション 2 件 ·
-
Add example using tags and topics再び着手できるかも @kmoralesml が 1845 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンgood first issue
hyperledger-firefly/samples#18 · コメント 2 件 · 担当者 1 名 ·
-
Add request/response example再び着手できるかも @apurvaaa が 1845 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンgood first issue
hyperledger-firefly/samples#17 · コメント 1 件 · 担当者 1 名 ·
hyperledger-firefly/samples の issue をすべて見る
似ている issue
-
area:editor bug issue-form:bug P0 platform:windows review: low
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
1lck/Lithe-IDEA#1388 ·
メンテナーはふだん 1 日以内に返信
-
fix(api): isToolAuditEnabled swallows database read errors on auditToolOperations without loggingオープンarea: backend bug priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
snapotter-hq/SnapOtter#3238 ·
メンテナーはふだん 1 日以内に返信
-
rig up --plan times out after 5 s and reports an UNKNOWN outcome while the daemon completes the planオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
modelcontextprotocol/servers#5216 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信