ipfs-examples · ElPaisano · May 23, 2023
diff --git a/examples/helia-readable-stream/.gitignore b/examples/helia-readable-stream/.gitignore
@@ -0,0 +1,8 @@
+node_modules
+build
+dist
+.docs
+.coverage
+node_modules
+package-lock.json
+yarn.lock
diff --git a/examples/helia-readable-stream/README.md b/examples/helia-readable-stream/README.md
@@ -0,0 +1,119 @@
+<p align="center">
+  <a href="https://js.ipfs.io" title="JS IPFS">
+    <img src="https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png" alt="IPFS in JavaScript logo" width="244" />
+  </a>
+</p>
+
+<h3 align="center"><b>Readable Stream</b></h3>
+
+<p align="center">
+  <b><i>Using duplex streams to add files to IPFS in the browser</i></b>
+  <br />
+  <br />
+  <img src="https://raw.githubusercontent.com/jlord/forkngo/gh-pages/badges/cobalt.png" width="200">
+  <br>
+  <a href="https://github.com/ipfs/js-ipfs/tree/master/docs">Explore the docs</a>
+  ·
+  <a href="https://codesandbox.io/">View Demo</a>
+  ·
+  <a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Report Bug</a>
+  ·
+  <a href="https://github.com/ipfs-examples/js-ipfs-examples/issues">Request Feature/Example</a>
+</p>
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About The Project](#about-the-project)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation and Running example](#installation-and-running-example)
+- [Usage](#usage)
+- [References](#references)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
+
+## About The Project
+
+- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
+- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser
+- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node
+- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
+- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
+- Check out https://docs.ipfs.io for tips, how-tos and more
+- See https://blog.ipfs.io for news and more
+- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
+
+## Getting Started
+
+### Prerequisites
+
+Make sure you have installed all of the following prerequisites on your development machine:
+
+- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
+- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
+
+### Installation and Running example
+
+```console
+> npm install
+> npm start
+```
+
+Now open your browser at `http://localhost:8888`
+
+## Usage
+
+If you have a number of files that you'd like to add to IPFS and end up with a hash representing the directory containing your files, you can invoke [`ipfs.add`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#add) with an array of objects.
+
+But what if you don't know how many there will be in advance? You can add multiple files to a directory in IPFS over time by using [`ipfs.addReadableStream`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#addreadablestream).
+
+This example demonstrates the `Regular API`, top-level API for add, cat, get and ls Files on IPFS
+
+_For more examples, please refer to the [Documentation](#documentation)_
+
+## References
+
+- Documentation:
+  - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
+  - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
+  - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
+- Tutorials:
+  - [MFS API](https://proto.school/mutable-file-system)
+  - [Regular File API](https://proto.school/regular-files-api)
+
+## Documentation
+
+- [Config](https://docs.ipfs.io/)
+- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)
+- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)
+- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)
+- [Tutorials](https://proto.school)
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the IPFS Project
+2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing feature'`)
+4. Push to the Branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Want to hack on IPFS?
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
+
+The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
+
+Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).
+
+- **Check out existing issues** The [issue list](https://github.com/ipfs/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
+- **Look at the [IPFS Roadmap](https://github.com/ipfs/roadmap)** This are the high priority items being worked on right now
+- **Perform code reviews** More eyes will help
+  a. speed the project along
+  b. ensure quality, and
+  c. reduce possible future bugs.
+- **Add tests**. There can never be enough tests.
+- **Join the [Weekly Core Implementations Call](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next
diff --git a/examples/helia-readable-stream/index.html b/examples/helia-readable-stream/index.html
@@ -0,0 +1,113 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Add readable stream</title>
+
+    <link
+      rel="stylesheet"
+      href="https://unpkg.com/[email protected]/css/tachyons.min.css"
+      crossorigin
+    />
+    <link
+      rel="stylesheet"
+      href="https://unpkg.com/[email protected]/ipfs.css"
+      crossorigin
+    />
+    <link rel="shortcut icon" href="favicon.ico" />
+    <link rel="stylesheet" href="./src/style.css" />
+
+    <script type="module" src="./src/index.js" defer></script>
+  </head>
+
+  <body class="montserrat f5">
+    <header class="flex items-center pa3 bg-navy bb bw3 b--aqua">
+      <a href="https://ipfs.io" title="home">
+        <img
+          alt="IPFS logo"
+          src="./public/ipfs-logo.svg"
+          style="height: 50px"
+          class="v-top"
+        />
+      </a>
+    </header>
+
+    <main class="pa4-l bg-snow mw7 mv5 center pa4">
+      <h1 class="pa0 f2 ma0 mb4 aqua tc">Readable stream example</h1>
+
+      <h3>Files to add</h3>
+
+      <div id="examples"></div>
+
+      <h3>Add file</h3>
+
+      <form id="add-file">
+        <label for="file-directory" class="f5 ma0 pb2 aqua fw4 db"
+          >Directory</label
+        >
+        <input
+          class="input-reset bn black-80 bg-white pa3 w-100 mb3"
+          id="file-directory"
+          name="file-directory"
+          type="text"
+          value="directory"
+          placeholder="directory"
+          required
+        />
+
+        <label for="file-name" class="f5 ma0 pb2 aqua fw4 db">Name</label>
+        <input
+          class="input-reset bn black-80 bg-white pa3 w-100 mb3"
+          id="file-name"
+          name="file-name"
+          type="text"
+          placeholder="file.txt"
+          required
+        />
+
+        <label for="file-content" class="f5 ma0 pb2 aqua fw4 db">Content</label>
+        <input
+          class="input-reset bn black-80 bg-white pa3 w-100 mb3 ft"
+          id="file-content"
+          name="file-content"
+          type="text"
+          placeholder="Hello world"
+          required
+        />
+
+        <button
+          class="
+            button-reset
+            pv3
+            tc
+            bn
+            bg-animate bg-black-80
+            hover-bg-aqua
+            white
+            pointer
+            w-100
+          "
+          id="add-submit"
+          type="submit"
+        >
+          Add files
+        </button>
+      </form>
+
+      <h3>Output</h3>
+
+      <div class="window">
+        <div class="header"></div>
+        <div id="terminal" class="terminal">
+          <div id="output"></div>
+        </div>
+      </div>
+
+      <div id="preview" class="hidden mt3">
+        <h3>Preview files</h3>
+      </div>
+    </main>
+  </body>
+</html>
diff --git a/examples/helia-readable-stream/package.json b/examples/helia-readable-stream/package.json
@@ -0,0 +1,30 @@
+{
+    "name": "example-browser-add-readable-stream",
+    "version": "1.0.0",
+    "private": true,
+    "type": "module",
+    "description": "How to add readable streams in the browser",
+    "keywords": [],
+    "license": "MIT",
+    "scripts": {
+      "clean": "rimraf ./dist ./.cache ./node_modules/.vite",
+      "build": "vite build",
+      "serve": "vite dev --port 8888",
+      "start": "npm run serve",
+      "test": "npm run build && playwright test tests"
+    },
+    "browserslist": "last 1 Chrome version",
+    "dependencies": {
+      "ipfs-core": "^0.16.0"
+    },
+    "devDependencies": {
+      "@babel/core": "^7.14.8",
+      "@playwright/test": "^1.12.3",
+      "playwright": "^1.12.3",
+      "process": "^0.11.10",
+      "rimraf": "^3.0.2",
+      "test-util-ipfs-example": "^1.0.2",
+      "util": "^0.12.4",
+      "vite": "^3.1.0"
+    }
+  }