# Hubble

Hubble is a Typescript implementation of a [Farcaster Hub](https://github.com/farcasterxyz/protocol#4-hubs).

## 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](/apps/hubble/README.md).
- To talk to a running Hubble server, follow the instructions in [@farcaster/hub-nodejs](/packages/hub-nodejs/README.md).

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

## Contributing

Please see [CONTRIBUTING.md](./CONTRIBUTING.md)