mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-01-10 05:38:07 -05:00
23758b571f
## Why is this change needed? These were out of date as the network has grown. ## Merge Checklist - [x] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [ ] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [x] PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore) - [x] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on updating the documentation for the `Hubble` application, specifically regarding hardware requirements and setup instructions, including increases in RAM and disk space requirements. ### Detailed summary - Updated RAM requirement from `8GB` to `16GB` for the `Mainnet Hub`. - Increased disk space requirement from `20GB` to `300GB` for the `Mainnet Hub`. - Adjusted disk size in `main.tf` from `200GB` to `300GB`. - Updated storage requirement from `200GB` to `300GB` in installation instructions. - Changed exposed ports from `2282 - 2285` to `2282 & 2283` in installation instructions. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
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 |