Add step-by-step instructions to README.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 40/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- node.js, react, typescript
- Domain
- documentation
Research direction
Start by opening README.md and reviewing the existing guidance for the private-data-transfer-cli and private-data-transfer-ui samples. Use the listed Node.js version checks, npm install steps, npm run start commands, and UI port 3000 details to organize a step-by-step setup flow; done means a non-Node.js developer can launch both samples and understand what each demonstrates.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- TypeScript
- Stars
- 25
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from hyperledger-firefly/samples
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
hyperledger-firefly/samples#20 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
hyperledger-firefly/samples#36 · 2 reactions ·
-
Add example using tags and topicsMay be free again @kmoralesml claimed this 1845 days ago, and no pull request is open. Opengood first issue
hyperledger-firefly/samples#18 · 2 comments · 1 assignee ·
-
Add request/response exampleMay be free again @apurvaaa claimed this 1845 days ago, and no pull request is open. Opengood first issue
hyperledger-firefly/samples#17 · 1 comment · 1 assignee ·
All issues in hyperledger-firefly/samples
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
logancyang/obsidian-copilot#3753 ·
Maintainers usually reply within 1 day
-
area: presentation severity: important
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
voithos-labs/aragonite#763 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
diegosouzapw/OmniRoute#17386 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 72/100
super-productivity/super-productivity#10982 · 1 comment ·
Maintainers usually reply within 1 day