Hubble Monorepo

This monorepo contains Hubble, a Farcaster Hub implementation, and other packages used to communicate with Hubble.

Getting Started

See CONTRIBUTING.md to set up your developer environment and learn about how to contribute.

Code Organization

The repository is a monorepo with a primary application in the /apps/ folder that imports several packages /packages/. It is written primarily in Typescript and uses Yarn to orchestrate tasks and TurboRepo as its build system. Some performance intensive code is written in Rust and compiled with Cargo.

Applications

App Name	Description
@farcaster/hubble	A Farcaster Hub implementation

To run Hubble, please see the Hubble docs.

Packages

Package Name	Description
@farcaster/shuttle	A package that streams Hubble events to Postgres
@farcaster/hub-nodejs	A Node.js client library for Hubble
@farcaster/hub-web	A Browser client library for Hubble
@farcaster/core	Shared code between all packages