bee-js - The Swarm JS Library
bee-js is a JavaScript SDK for building applications using the Swarm decentralized storage and communication network. It allows you to interact with a local or remote Bee node within your NodeJS project.
The following documentation will guide you through installing and using bee-js. Take your first steps with bee-js in the Getting Started section.
Ethereum addresses / keys are mentioned throughout the documentation. Please note that this refers to the Ethereum format only, and does not indicate the Ethereum blockchain itself. Swarm is built on the Gnosis Blockchain which is a fork of Ethereum, and uses the same key and addressing schemes.
Development
We'd love you to join us! Are you up to the challenge of helping us to create bee-js and the other incredible technologies we're building? Have a look at our GitHub organization, Ethersphere.
Community
There is a vibrant and buzzing community behind Swarm. Get involved in one of our group channels.
Reporting a bug
If anything isn't working, get in touch and let us know! Every Bee is important to us and we'll get right to work on fixing it for you as soon as possible. 🐝
Examples
create-swarm-app scaffolds a working project with bee-js already installed and configured, including a React app built with Vite. It is the quickest way to see a complete, running example:
npm init swarm-app@latest my-dapp vite-tsx
See Getting Started for the other available templates.