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: about 2 months 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-04-13T06:14:42.000Z (3 months ago)
• Last Synced: 2024-04-13T13:01:32.820Z (3 months ago)
• Topics: farcaster
• Language: TypeScript
• Homepage: https://www.thehubble.xyz
• Size: 11.2 MB
• Stars: 529
• Watchers: 20
• Forks: 260
• Open Issues: 53
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-farcaster - farcasterxyz/hub

README

        
# 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)