Bitsocial React Hooks

在互联网上建立自己的地盘。

React hooks的社区、提要、对话、配置文件、帐户和发布 Bitsocial协议。自带接口; 钩子通过Zustand存储将其连接到共享协议状态。

文档 · 去游乐场试试 · API和配方 · npm

编辑组件并查看结果。游乐场使用模拟内容，不发布任何内容。

支持 反应16.8 +。所使用的 陈5.

开始构建

将这个包添加到现有的React应用中：

yarn add @bitsocial/bitsocial-react-hooks

在浏览器中使用一个现有的社区名来呈现这个组件：

import { useCommunity } from "@bitsocial/bitsocial-react-hooks";

export default function CommunityCard({ name }) {
  const community = useCommunity({ community: { name } });

  if (!community.hasCachedData) {
    return (
      <p role="status">
        {community.error?.message || "Loading community…"}
      </p>
    );
  }

  return (
    <article>
      <h1>{community.title || name}</h1>
      <p>{community.description}</p>
    </article>
  );
}

该包将自动初始化本地帐户。你也可以通过以下方式来定义一个社区 { publicKey }，或两者皆过 { name, publicKey }。钩子共享缓存数据和订阅；使用 syncState 当需要显示后台刷新进度时。

浏览文档

阅读以下指南： hooks.bitsocial.net，或在此浏览其来源：

• 快速入门 -建立你的第一个feed。
• 核心概念 -社区、帐户、状态和发布。
• 完整的API和配方 -完整的钩子参考和实际的例子。
• 模拟的内容 -开发一个UI与样本数据。
• 人工智能环境， llms.txt, llms-full.txt -编码助理的文档。

在本地运行网站

该网站位于 website/。在浏览器中打开playground和docs：

cd website
corepack yarn install --immutable
corepack yarn start

贡献

使用Node 22.19或更新版本以及存储库固定的Yarn 4版本：

nvm install
nvm use
corepack yarn install
corepack yarn build

读 测试和开发， 贡献者的指导, 验证 集中检查。保持API示例与公共导出和类型保持一致；文档更改后，运行 corepack yarn llms:generate.

许可证

gpl - 3.0 -或-.