Skip to main content

Earthstar

This is a beta release of Earthstar 11, and is still in progress!

Earthstar is a general purpose distributed data store, designed with the social realities of peer-to-peer computing kept in mind. It is powered by Willow.

This is a reference implementation written in Typescript, powered by willow-js. You can use it to add Earthstar functionality to applications running on servers, browsers, the command line, or anywhere else JavaScript can be run.

Detailed API documentation for this module can be found here.

This document is concerned with the usage of this module’s APIs. To learn more about what Earthstar is, please see these links:

To learn more about running Earthstar servers, see README_SERVERS

To learn about contributing to this codebase, please see CONTRIBUTING.

Getting started

We’re just getting started too (i.e. with this README), so for now get started with this:

const peer = new Peer({
  password: "password1234",
  runtime: new RuntimeDriverUniversal(),
  storage: new StorageDriverMemory();,
});