OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / filesharing-react-app-example / api-extract.json

36 lines · json ref:
{
  "repo": "filesharing-react-app-example",
  "timestamp": "2026-01-16T23:39:46.538Z",
  "entryPoint": "index.html",
  "exports": {
    "packageJson": {
      "main": "index.html",
      "type": "module"
    }
  },
  "api": {
    "file": "index.html",
    "exports": [],
    "classes": [],
    "functions": []
  },
  "readme": {
    "content": "# filesharing-react-app-example\n\nThis example app shows how to build a simple file sharing app where all files are shared between everyone who use the app.\n\nTo read more details about how to use Pear, read the [Getting Started guide](https://docs.pears.com/guides/getting-started).\n\n## How to run\n\n[Pear](https://docs.pears.com/guides/getting-started) is a prerequisite, which can be installed with `npm i -g pear`.\n\n```\n$ git clone https://github.com/holepunchto/filesharing-react-app-example.git\n$ cd filesharing-react-app-example\n$ npm install \n$ pear run .\n```\n\nWhen a Pear app runs, it uses a local storage that's the same for all instances. To test the file sharing app, it would be good run multiple instances that looks different. To do that, use the `--store/-s` parameter for `pear`.\n\nIn one terminal:\n\n```\n$ pear run -s /tmp/fs1 .\n```\n\nIn another terminal:\n\n```\n$ pear run -s /tmp/fs2 .\n```\n\n## How to release\n\nWhen a Pear app is released, it can be run by others. Read more about this in ",
    "sections": [
      "intro",
      "how to run",
      "how to release"
    ],
    "hasApi": false,
    "hasExamples": true,
    "exampleCount": 6,
    "examples": [
      "$ git clone https://github.com/holepunchto/filesharing-react-app-example.git\n$ cd filesharing-react-app-example\n$ npm install \n$ pear run .",
      "$ pear run -s /tmp/fs1 .",
      "$ pear run -s /tmp/fs2 ."
    ]
  },
  "patterns": [
    "peer-discovery"
  ]
}