hub-monorepo/README.md

Hubble

Hubble is a Typescript implementation of a Farcaster Hub.

Getting Started

Hubble is organized as a monorepo with a stand-alone Hubble application, a library to interact with Hubble and shared utility packages.

• To run an instance of Hubble, follow the instructions in @farcaster/hubble.
• To talk to a running Hubble server, follow the instructions in @farcaster/hub-nodejs.

Package Name	Description
@farcaster/hubble	An executable Farcaster Hub
@farcaster/hub-nodejs	A Javascript library to interact with Hubble
@farcaster/protobufs	Protobufs schemas and generated files for Hubble
@farcaster/utils	Shared utility methods

Contributing

Please see CONTRIBUTING.md