{"id":18908828,"url":"https://github.com/orbitdb/examples","last_synced_at":"2025-09-04T18:32:16.008Z","repository":{"id":189249568,"uuid":"680125120","full_name":"orbitdb/examples","owner":"orbitdb","description":"Implementing OrbitDB on various Javascript platforms.","archived":false,"fork":false,"pushed_at":"2024-02-05T19:00:56.000Z","size":1594,"stargazers_count":3,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-08T09:38:48.765Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orbitdb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-18T11:59:00.000Z","updated_at":"2024-09-29T10:05:28.000Z","dependencies_parsed_at":"2023-08-19T01:23:12.733Z","dependency_job_id":"4c359cbd-1fa6-47b9-a400-f9d93c764d33","html_url":"https://github.com/orbitdb/examples","commit_stats":null,"previous_names":["orbitdb/orbitdb-examples","orbitdb/examples"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Fexamples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Fexamples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Fexamples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbitdb%2Fexamples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orbitdb","download_url":"https://codeload.github.com/orbitdb/examples/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231983766,"owners_count":18455945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T09:28:50.736Z","updated_at":"2024-12-31T12:21:26.975Z","avatar_url":"https://github.com/orbitdb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OrbitDB Examples\n\n\u003cp align=\"left\"\u003e\n  \u003cimg src=\"https://github.com/orbitdb/orbitdb/blob/main/images/orbit_db_logo_color.png\" width=\"256\" /\u003e\n\u003c/p\u003e\n\nThis repository contains some basic examples on how to implement OrbitDB in Javascript using various methods and frameworks.\n\n## Usage\n\nDifferent frameworks and implementations are provided. Below are installation and usage details for each example.\n\nTo start, check out this repository:\n\n```bash\ngit clone https://github.com/orbitdb/orbitdb-examples.git\n```\n\n### Nodejs\n\nBundle OrbitDB in a node application.\n\nThe Node.js demo provides an example of how OrbitDB uses IPFS to replicate records across peers.\n\nInstall the 3rd party NPM packages and run the example:\n\n```bash\ncd ./nodejs\nnpm i\n```\n\nRun two terminal windows, terminal 1 and terminal 2.\n\nIn terminal 1, run the following:\n\n```bash\nnode index.js\n```\n\nOnce running, an OrbitDB address will be printed in the form /orbitdb/\u003chash\u003e. Copy this before moving on to the next step.\n\nIn terminal 2, run index.js, passing the OrbitDB address you copied from the other window:\n\n```bash\nnode index.js /orbitdb/\u003chash\u003e\n```\n\nYou should see the second peer add a record which the first peer should also print to the screen.\n\nTo close the peers and exit the two instances of the daemon, press ctrl+c in each of the terminal windows.\n\n### Browser\n\nRun OrbitDB as a simple web app.\n\nLaunch a local web server. For example, you can use the [Python's HTTP server](https://docs.python.org/3/library/http.server.html):\n\n```\ncd ./browser\npython3 -m http.server 8081\n```\n\nBrowse to http://localhost:8081/\n\n### Browser ES\n\nRun OrbitDB as a simple web app for ES compatible browsers (e.g. \u003cscript type=\"module\"/\u003e).\n\nLaunch a local web server. For example, you can use the [Python's HTTP server](https://docs.python.org/3/library/http.server.html):\n\n```\ncd ./browser-es\npython3 -m http.server 8081\n```\n\nBrowse to http://localhost:8081/\n\n### Webpack\n\nIntegrate OrbitDB with a webpacked app.\n\nInstall the 3rd party NPM packages:\n\n```\ncd ./webpack\nnpm i\n```\n\nLaunch a local web server. For example, you can use the [Python's HTTP server](https://docs.python.org/3/library/http.server.html):\n\n```\npython3 -m http.server 8081\n```\n\nBrowse to http://localhost:8081/\n\n### React\n\nIntegrate OrbitDB in a ReactJS app.\n\nInstall the 3rd party NPM packages and run:\n\n```\ncd ./react\nnpm i\nnpm run start\n```\n\nBrowse to the specified localhost URL in your web browser.\n\n### Vue + Vite\n\nIntegrate OrbitDB in a VueJS app.\n\nInstall the 3rd party NPM packages and run:\n\n```\ncd ./vue-vite\nnpm i\nnpm run dev\n```\n\nBrowse to the specified localhost URL in your web browser.\n\n## License\n\n[MIT](LICENSE) © 2023 OrbitDB Community","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbitdb%2Fexamples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forbitdb%2Fexamples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbitdb%2Fexamples/lists"}