Peerbit is as easy-to-use as Firebase and provide P2P functionality like OrbitDB or GunJS yet with performance for data-intensive applications like live-streaming and cloud-gaming. It’s built on top of Libp2p (and works with IPFS) supporting encryption, sharding and discoverability (searching).
Your database schema can remain very simple but still utilize P2P networks, auto-scaling, E2E-encryption, discoverability and all other features you’d expect from a database.
Peerbit is performant, so performant in fact you can use it for streaming video by having peers subscribing to database updates. In a low latency setting, you can achieve around 1000 replications a second and have a thoughput of 100 MB/s.
-
Install Peerbit by following the simple setup instructions in our Installation Guide.
-
Dive into our comprehensive Documentation or checkout the Example repository to explore the powerful features and learn how to leverage Peerbit to its fullest potential.
-
Join us on Matrix to connect, share ideas, and collaborate with like-minded individuals.
Peerbit is an open-source project, and we welcome contributions from developers like you! Feel free to contribute code, report issues, and submit feature requests. Together, let's shape the future of Peerbit.
IMPORTANT: Peerbit uses yarn.
- Check yarn version:
yarn -v
should print something - Install:
yarn
- Build:
yarn build
- Run tests:
yarn test
in root in a specifc subpackage
You might possibly need to CMD + Shift + P and then enter to restart the typescript server after the build step.
To create a new package, follow the following steps:
- Clone the time folder within /packages/utils/time to the desired destination and rename it
- Update the package.json
name
,description
,version
fields - Possibly add other depencencies to the package.json
dependencies
field (like@peerbit/crypto
) - Delete contents in CHANGELOG.md
- Update the root package.json
workspaces
field - Update root lerna.json
workspaces
field - run yarn once in root
We recommend running tests with the VS Code integration though: https://github.com/CoderLine/mocha-vscode