{"id":14956221,"url":"https://github.com/peer-base/peer-base","last_synced_at":"2025-04-07T05:10:03.352Z","repository":{"id":55865793,"uuid":"135990605","full_name":"peer-base/peer-base","owner":"peer-base","description":"Build real-time collaborative DApps on top of IPFS","archived":false,"fork":false,"pushed_at":"2020-05-29T18:12:25.000Z","size":6432,"stargazers_count":228,"open_issues_count":93,"forks_count":22,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-31T04:06:04.907Z","etag":null,"topics":["collaboration","crdt","decentralized","delta-crdts","ipfs","peer","peer-star"],"latest_commit_sha":null,"homepage":"","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/peer-base.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-04T07:57:23.000Z","updated_at":"2024-08-23T19:40:45.000Z","dependencies_parsed_at":"2022-08-15T08:01:13.764Z","dependency_job_id":null,"html_url":"https://github.com/peer-base/peer-base","commit_stats":null,"previous_names":["ipfs-shipyard/peer-star-app"],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peer-base%2Fpeer-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peer-base%2Fpeer-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peer-base%2Fpeer-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peer-base%2Fpeer-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peer-base","download_url":"https://codeload.github.com/peer-base/peer-base/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595334,"owners_count":20963943,"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":["collaboration","crdt","decentralized","delta-crdts","ipfs","peer","peer-star"],"created_at":"2024-09-24T13:12:33.613Z","updated_at":"2025-04-07T05:10:03.321Z","avatar_url":"https://github.com/peer-base.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# peer-base\n\nBuild real-time collaborative DApps on top of IPFS\n\n[![Build Status](https://travis-ci.org/peer-base/peer-base.svg?branch=master)](https://travis-ci.org/peer-base/peer-base) [![Greenkeeper badge](https://badges.greenkeeper.io/peer-base/peer-base.svg)](https://greenkeeper.io/) [![made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)\n\n\n* [Example app](examples/react-app)\n* [How to run the example app](#run-example-app)\n\n# Documentation\n\n* [Code structure](https://github.com/peer-base/peer-base/blob/master/docs/CODE-STRUCTURE.md)\n* [Protocol](https://github.com/peer-base/peer-base/blob/master/docs/PROTOCOL.md)\n* [Performance tests](https://github.com/peer-base/peer-base/blob/master/docs/PERFORMANCE-TESTS.md)\n* [Membership Simulator](https://github.com/peer-base/peer-base/blob/master/docs/MEMBERSHIP-SIM.md)\n\n## Install\n\n```bash\n$ npm install peer-base\n```\n\n## Import\n\n```js\nconst PeerBase = require('peer-base')\n```\n\n# API\n\n[API docs](docs/API.md)\n\n# Run example app\n\nClone this repo.\n\n```bash\n$ cd peer-base\n$ cd examples/react-app\n$ npm install\n```\n\nIn a different window, on the same dir, start the rendezvous server:\n\n```bash\n$ npm run start:rv\n```\n\nIn a different window, on the same dir, run the app server:\n\n```bash\n$ npm start\n```\n\nOpen [http://localhost:3000](http://localhost:3000) and test the app.\n\n# Tests\n\nClone this repo and run:\n\n```\n$ npm install\n$ npm test\n```\n\n## Testing a deployed pinner\n\nIf you want to make sure your deployed pinner is working correctly, there is a\nutility-test that you can run with `npm run test:post-deploy` that will ensure\nyour deployed pinner works correctly.\n\nFirst you need to export environment variables to ensure the assertion values\nare correct for your environment, then you can run the test. Example:\n\n```\nexport PEER_BASE_APP_NAME=peer-pad/2\nexport PEER_BASE_SWARM_ADDRESS=/dns4/localhost/tcp/9090/ws/p2p-websocket-star\nexport PEER_BASE_PINNER_ID=Qmb9WDZUnUzEmZwkbMMGi4cV65F1sqcQa49dfZy9baRBJo\nnpm run test:post-deploy\n```\n\n# Infrastructure\n\nThe infrastructure for peer-base and related applications is managed via\nhttps://github.com/peer-base/peer-base/\n\n# Debug\n\nYou can activate the debugging logs by manipulating the `DEBUG` environment variable. Example:\n\n```bash\n$ DEBUG=peer-star:* npm test\n```\n\nFor file-specific `DEBUG` values, see the source code and look for usages of the `debug` package.\n\n## Lead Maintainer\n\n[Jim Pick](https://github.com/jimpick)\n\n# Contribute\n\nPeer-base and the IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:\n\n  * Check out [existing issues](https://github.com/peer-base/peer-base/issues). This would be especially useful for modules in active development. Some knowledge of IPFS may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.\n  * **Perform code reviews**. More eyes will help (a) speed the project along, (b) ensure quality, and (c) reduce possible future bugs.\n  * **Add tests**. There can never be enough tests.\n\n## Want to hack on peer-base?\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n\n# License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeer-base%2Fpeer-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeer-base%2Fpeer-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeer-base%2Fpeer-base/lists"}