# Hubble Monorepo

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


## Getting Started

1. To run Hubble, see the [Hubble docs](https://www.thehubble.xyz/).
1. To use Hubble, see the [hub-nodejs docs](./packages/hub-nodejs/docs/README.md).
1. To use the HTTP API to read Hubble data, see the [HTTP API docs](https://www.thehubble.xyz/docs/httpapi/httpapi.html)

## Packages

| Package Name                                  | Description                                                                    |
| --------------------------------------------- | ------------------------------------------------------------------------------ |
| [@farcaster/hubble](./apps/hubble)             | A Farcaster Hub implementation |
| [@farcaster/hub-nodejs](./packages/hub-nodejs) | A Node.js client library for Hubble |
| [@farcaster/hub-web](./packages/hub-web)       | A Browser client library for Hubble |
| [@farcaster/core](./packages/core)             | Shared code between all packages |


## Contributing

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