https://github.com/farcasterxyz/hub-monorepo

Implementation of the Farcaster Hub specification and supporting libraries for building applications on Farcaster
https://github.com/farcasterxyz/hub-monorepo

farcaster

Last synced: 2 days ago
JSON representation

Implementation of the Farcaster Hub specification and supporting libraries for building applications on Farcaster

• Host: GitHub
• URL: https://github.com/farcasterxyz/hub-monorepo
• Owner: farcasterxyz
• License: mit
• Created: 2022-03-16T23:28:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T07:54:33.000Z (5 days ago)
• Last Synced: 2024-12-09T01:48:55.709Z (4 days ago)
• Topics: farcaster
• Language: TypeScript
• Homepage: https://www.thehubble.xyz
• Size: 13.6 MB
• Stars: 719
• Watchers: 26
• Forks: 420
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-farcaster - farcasterxyz/hub
• awesome-farcaster-dev - `hub-monorepo`
• awesome-farcaster-dev - `hub-monorepo`

README

        
# Hubble Monorepo

This monorepo contains [Hubble](https://docs.farcaster.xyz/hubble/hubble), a Farcaster Hub implementation, and other packages used to communicate with Hubble.

## Getting Started

See [CONTRIBUTING.md](./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](https://www.typescriptlang.org/) and uses [Yarn](https://yarnpkg.com/) to orchestrate tasks and [TurboRepo](https://turbo.build/) as its build system. Some performance intensive code is written in Rust and compiled with Cargo.

### Applications

| App Name                                      | Description                                                                    |

| --------------------------------------------- | ------------------------------------------------------------------------------ |

| [@farcaster/hubble](./apps/hubble)             | A Farcaster Hub implementation |

To run Hubble, please see the [Hubble docs](https://docs.farcaster.xyz/hubble/hubble).

### Packages

| Package Name                                  | Description                                                                    |

| --------------------------------------------- | ------------------------------------------------------------------------------ |

| [@farcaster/shuttle](./packages/shuttle)       | A package that streams Hubble events to Postgres |

| [@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 |