docs: bring examples back

achingbrain · achingbrain · commit 1489a77c3a06 · 2020-06-22T15:54:50.000+01:00
diff --git a/.env b/.env
@@ -0,0 +1,3 @@
+# required because react-scripts scans *up* the tree from this project and finds
+# a conflicting version of eslint in the node_modules dir for js-ipfs.
+SKIP_PREFLIGHT_CHECK=true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.1.2](https://github.com/ipfs/js-ipfs/compare/example-browser-create-react-app@0.1.1...example-browser-create-react-app@0.1.2) (2020-04-08)
+
+**Note:** Version bump only for package example-browser-create-react-app
+
+
+
+
+
+## 0.1.1 (2020-03-31)
+
+**Note:** Version bump only for package example-browser-create-react-app
diff --git a/README.md b/README.md
@@ -0,0 +1,87 @@
+## IPFS React app
+
+A minimal demonstration of how to use js-ipfs in a `create-react-app` generated app.
+
+It boots up a js-ipfs instance via a custom React hook in `./src/hooks/use-ipfs-factory.js`, which is called from `./src/App.js`, which is where the magic happens.
+
+![Screen shot of the js ipfs node id info](./screenshot.png)
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). **v2.1.3**
+
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.<br>
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br>
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.<br>
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br>
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br>
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+
+### Analyzing the Bundle Size
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+
+### Making a Progressive Web App
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+
+### Advanced Configuration
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+
+### Deployment
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+
+### `npm run build` fails to minify
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
diff --git a/package.json b/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "example-browser-create-react-app",
+  "version": "1.0.0",
+  "private": true,
+  "dependencies": {
+    "dot-prop": "^5.0.0",
+    "ipfs": "^0.46.0",
+    "ipfs-css": "^0.13.1",
+    "react": "^16.8.6",
+    "react-dom": "^16.8.6",
+    "react-scripts": "^3.2.0",
+    "tachyons": "^4.11.1"
+  },
+  "devDependencies": {
+    "test-ipfs-example": "^2.0.3"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "eject": "react-scripts eject",
+    "test": "test-ipfs-example",
+    "clean": "rm -rf ./build"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": [
+    ">0.2%",
+    "not dead",
+    "not ie <= 11",
+    "not op_mini all"
+  ]
+}
diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1, shrink-to-fit=no"
+    />
+    <meta name="theme-color" content="#000000" />
+    <!--
+      manifest.json provides metadata used when your web app is added to the
+      homescreen on Android. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>IPFS React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/public/manifest.json b/public/manifest.json
@@ -0,0 +1,15 @@
+{
+  "short_name": "IPFS React App",
+  "name": "IPFS Create React App Example",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/screenshot.png b/screenshot.png
diff --git a/src/App.js b/src/App.js
@@ -0,0 +1,52 @@
+import React from 'react'
+import useIpfsFactory from './hooks/use-ipfs-factory.js'
+import useIpfs from './hooks/use-ipfs.js'
+import logo from './ipfs-logo.svg'
+
+const App = () => {
+  const { ipfs, ipfsInitError } = useIpfsFactory({ commands: ['id'] })
+  const id = useIpfs(ipfs, 'id')
+  return (
+    <div className='sans-serif'>
+      <header className='flex items-center pa3 bg-navy bb bw3 b--aqua'>
+        <a href='https://ipfs.io' title='home'>
+          <img alt='IPFS logo' src={logo} style={{ height: 50 }} className='v-top' />
+        </a>
+        <h1 className='flex-auto ma0 tr f3 fw2 montserrat aqua'>IPFS React</h1>
+      </header>
+      <main>
+        {ipfsInitError && (
+          <div className='bg-yellow pa4 mw7 center mv4 white'>
+            Error: {ipfsInitError.message || ipfsInitError}
+          </div>
+        )}
+        {id && <IpfsId {...id} />}
+      </main>
+    </div>
+  )
+}
+
+const Title = ({ children }) => {
+  return (
+    <h2 className='f5 ma0 pb2 tracked aqua fw4 montserrat'>{children}</h2>
+  )
+}
+
+const IpfsId = (props) => {
+  if (!props) return null
+  return (
+    <section className='bg-snow mw7 center mt5'>
+      <h1 className='f3 fw4 ma0 pv3 aqua montserrat tc' data-test='title'>Connected to IPFS</h1>
+      <div className='pa4'>
+        {['id', 'agentVersion'].map((key) => (
+          <div className='mb4' key={key}>
+            <Title>{key}</Title>
+            <div className='bg-white pa2 br2 truncate monospace' data-test={key}>{props[key]}</div>
+          </div>
+        ))}
+      </div>
+    </section>
+  )
+}
+
+export default App
diff --git a/src/App.test.js b/src/App.test.js
@@ -0,0 +1,9 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+import App from './App'
+
+it('renders without crashing', () => {
+  const div = document.createElement('div')
+  ReactDOM.render(<App />, div)
+  ReactDOM.unmountComponentAtNode(div)
+})
diff --git a/src/hooks/use-ipfs-factory.js b/src/hooks/use-ipfs-factory.js
@@ -0,0 +1,57 @@
+import Ipfs from 'ipfs'
+import { useEffect, useState } from 'react'
+
+let ipfs = null
+
+/*
+ * A quick demo using React hooks to create an ipfs instance.
+ *
+ * Hooks are brand new at the time of writing, and this pattern
+ * is intended to show it is possible. I don't know if it is wise.
+ *
+ * Next steps would be to store the ipfs instance on the context
+ * so use-ipfs calls can grab it from there rather than expecting
+ * it to be passed in.
+ */
+export default function useIpfsFactory () {
+  const [isIpfsReady, setIpfsReady] = useState(Boolean(ipfs))
+  const [ipfsInitError, setIpfsInitError] = useState(null)
+
+  useEffect(() => {
+    // The fn to useEffect should not return anything other than a cleanup fn,
+    // So it cannot be marked async, which causes it to return a promise,
+    // Hence we delegate to a async fn rather than making the param an async fn.
+    async function startIpfs () {
+      if (ipfs) {
+        console.log('IPFS already started')
+      } else if (window.ipfs && window.ipfs.enable) {
+        console.log('Found window.ipfs')
+        ipfs = await window.ipfs.enable({ commands: ['id'] })
+      } else {
+        try {
+          console.time('IPFS Started')
+          ipfs = await Ipfs.create()
+          console.timeEnd('IPFS Started')
+        } catch (error) {
+          console.error('IPFS init error:', error)
+          ipfs = null
+          setIpfsInitError(error)
+        }
+      }
+
+      setIpfsReady(Boolean(ipfs))
+    }
+
+    startIpfs()
+    return function cleanup () {
+      if (ipfs && ipfs.stop) {
+        console.log('Stopping IPFS')
+        ipfs.stop().catch(err => console.error(err))
+        ipfs = null
+        setIpfsReady(false)
+      }
+    }
+  }, [])
+
+  return { ipfs, isIpfsReady, ipfsInitError }
+}
diff --git a/src/hooks/use-ipfs.js b/src/hooks/use-ipfs.js
@@ -0,0 +1,26 @@
+import { useState, useEffect } from 'react'
+import dotProp from 'dot-prop'
+
+/*
+ * Pass the command you'd like to call on an ipfs instance.
+ *
+ * Uses setState to capture the response, so your component
+ * will re-render when the result turns up.
+ *
+ */
+export default function useIpfs (ipfs, cmd, opts) {
+  const [res, setRes] = useState(null)
+  useEffect(() => {
+    callIpfs(ipfs, cmd, opts, setRes)
+  }, [ipfs, cmd, opts])
+  return res
+}
+
+async function callIpfs (ipfs, cmd, opts, setRes) {
+  if (!ipfs) return null
+  console.log(`Call ipfs.${cmd}`)
+  const ipfsCmd = dotProp.get(ipfs, cmd)
+  const res = await ipfsCmd(opts)
+  console.log(`Result ipfs.${cmd}`, res)
+  setRes(res)
+}
diff --git a/src/index.css b/src/index.css
@@ -0,0 +1,2 @@
+@import "../node_modules/tachyons";
+@import "../node_modules/ipfs-css";
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,6 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+import './index.css'
+import App from './App'
+
+ReactDOM.render(<App />, document.getElementById('root'))
diff --git a/src/ipfs-logo.svg b/src/ipfs-logo.svg
@@ -0,0 +1 @@
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 553 235.3"><defs><style>.cls-1{fill:#fff}.cls-2{fill:#469ea2}.cls-3{fill:#6acad1}.cls-4,.cls-5{fill:#083b54}.cls-4{fill-opacity:.15}.cls-5{fill-opacity:.05}</style></defs><title>IPFS logo (new)</title><path class="cls-1" d="M239 63h17.8v105H239V63zm35.6 0h36.3c7.9 0 14.5.9 19.6 2.6s9.2 4.1 12.1 7.1a24.45 24.45 0 0 1 6.2 10.2 40.75 40.75 0 0 1 1.8 12.1 45.69 45.69 0 0 1-1.8 12.9 26.58 26.58 0 0 1-6.2 10.8 30.59 30.59 0 0 1-12.1 7.3c-5.1 1.8-11.5 2.7-19.3 2.7h-19.1V168h-17.5V63zm36.2 51a38.37 38.37 0 0 0 11.1-1.3 16.3 16.3 0 0 0 6.8-3.7 13.34 13.34 0 0 0 3.5-5.8 29.75 29.75 0 0 0 1-7.6 25.68 25.68 0 0 0-1-7.7 12 12 0 0 0-3.6-5.5 17.15 17.15 0 0 0-6.9-3.4 41.58 41.58 0 0 0-10.9-1.2h-18.5V114h18.5zm119.9-51v15.3h-49.2V108h46.3v15.4h-46.3V168h-17.8V63h67zm26.2 72.9c.8 6.9 3.3 11.9 7.4 15s10.4 4.7 18.6 4.7a32.61 32.61 0 0 0 10.1-1.3 20.52 20.52 0 0 0 6.6-3.5 12 12 0 0 0 3.5-5.2 19.08 19.08 0 0 0 1-6.4 16.14 16.14 0 0 0-.7-4.9 12.87 12.87 0 0 0-2.6-4.5 16.59 16.59 0 0 0-5.1-3.6 35 35 0 0 0-8.2-2.4l-13.4-2.5a89.76 89.76 0 0 1-14.1-3.7 33.51 33.51 0 0 1-10.4-5.8 22.28 22.28 0 0 1-6.3-8.8 34.1 34.1 0 0 1-2.1-12.7 26 26 0 0 1 11.3-22.4 36.35 36.35 0 0 1 12.6-5.6 65.89 65.89 0 0 1 15.8-1.8c7.2 0 13.3.8 18.2 2.5a34.46 34.46 0 0 1 11.9 6.5 28.21 28.21 0 0 1 6.9 9.3 42.1 42.1 0 0 1 3.2 11l-16.8 2.6c-1.4-5.9-3.7-10.2-7.1-13.1s-8.7-4.3-16.1-4.3a43.9 43.9 0 0 0-10.5 1.1 19.47 19.47 0 0 0-6.8 3.1 11.63 11.63 0 0 0-3.7 4.6 14.08 14.08 0 0 0-1.1 5.4c0 4.6 1.2 8 3.7 10.3s6.9 4 13.2 5.3l14.5 2.8c11.1 2.1 19.2 5.6 24.4 10.5s7.8 12.1 7.8 21.4a31.37 31.37 0 0 1-2.4 12.3 25.27 25.27 0 0 1-7.4 9.8 36.58 36.58 0 0 1-12.4 6.6 56 56 0 0 1-17.3 2.4c-13.4 0-24-2.8-31.6-8.5s-11.9-14.4-12.6-26.2h18z"/><path class="cls-2" d="M30.3 164l84 48.5 84-48.5V67l-84-48.5-84 48.5v97z"/><path class="cls-3" d="M105.7 30.1l-61 35.2a18.19 18.19 0 0 1 0 3.3l60.9 35.2a14.55 14.55 0 0 1 17.3 0l60.9-35.2a18.19 18.19 0 0 1 0-3.3L123 30.1a14.55 14.55 0 0 1-17.3 0zm84 48.2l-61 35.6a14.73 14.73 0 0 1-8.6 15l.1 70a15.57 15.57 0 0 1 2.8 1.6l60.9-35.2a14.73 14.73 0 0 1 8.6-15V79.9a20 20 0 0 1-2.8-1.6zm-150.8.4a15.57 15.57 0 0 1-2.8 1.6v70.4a14.38 14.38 0 0 1 8.6 15l60.9 35.2a15.57 15.57 0 0 1 2.8-1.6v-70.4a14.38 14.38 0 0 1-8.6-15L38.9 78.7z"/><path class="cls-2" d="M114.3 29l75.1 43.4v86.7l-75.1 43.4-75.1-43.4V72.3L114.3 29m0-10.3l-84 48.5v97l84 48.5 84-48.5v-97l-84-48.5z"/><path class="cls-2" d="M114.9 132h-1.2A15.66 15.66 0 0 1 98 116.3v-1.2a15.66 15.66 0 0 1 15.7-15.7h1.2a15.66 15.66 0 0 1 15.7 15.7v1.2a15.66 15.66 0 0 1-15.7 15.7zm0 64.5h-1.2a15.65 15.65 0 0 0-13.7 8l14.3 8.2 14.3-8.2a15.65 15.65 0 0 0-13.7-8zm83.5-48.5h-.6a15.66 15.66 0 0 0-15.7 15.7v1.2a15.13 15.13 0 0 0 2 7.6l14.3-8.3V148zm-14.3-89a15.4 15.4 0 0 0-2 7.6v1.2a15.66 15.66 0 0 0 15.7 15.7h.6V67.2L184.1 59zm-69.8-40.3L100 26.9a15.73 15.73 0 0 0 13.7 8.1h1.2a15.65 15.65 0 0 0 13.7-8l-14.3-8.3zM44.6 58.9l-14.3 8.3v16.3h.6a15.66 15.66 0 0 0 15.7-15.7v-1.2a16.63 16.63 0 0 0-2-7.7zM30.9 148h-.6v16.2l14.3 8.3a15.4 15.4 0 0 0 2-7.6v-1.2A15.66 15.66 0 0 0 30.9 148z"/><path class="cls-4" d="M114.3 213.2v-97.1l-84-48.5v97.1z"/><path class="cls-5" d="M198.4 163.8v-97l-84 48.5v97.1z"/></svg>
diff --git a/test.js b/test.js
@@ -0,0 +1,16 @@
+'use strict'
+
+const pkg = require('./package.json')
+
+module.exports = {
+  [pkg.name]: function (browser) {
+    browser
+      .url(process.env.IPFS_EXAMPLE_TEST_URL)
+      .waitForElementVisible('[data-test=title]')
+      .assert.containsText('[data-test=title]', 'Connected to IPFS')
+      .assert.elementPresent('[data-test=id')
+      .assert.elementPresent('[data-test=agentVersion')
+      .end()
+  }
+}
+

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# required because react-scripts scans up the tree from this project and finds`
	`2`	`+# a conflicting version of eslint in the node_modules dir for js-ipfs.`
	`3`	`+SKIP_PREFLIGHT_CHECK=true`