Skip to main content
在本指南中,您将学习如何使用 Monad Farcaster Mini App 模板 来构建应用。 该模板演示了所有 Mini App 能力,并允许您轻松修改,以便构建您自己的 Mini App。

克隆模板

您可以使用以下命令将 Mini App 模板克隆到本地机器:

安装依赖

.env.example 复制为 .env.local

运行模板

在 Farcaster Embed 工具中查看应用

Farcaster 提供了一个方便的 Embed 工具,可用于在您发布 Mini App 之前进行检查。 不幸的是,该嵌入工具只能与远程 URL 一起使用。输入 localhost URL 是不起作用的。 作为一种变通方案,您可以使用 cloudflaredngrok 等工具让本地应用可以远程访问。在本指南中我们将使用 cloudflared

安装 Cloudflared

有关更多安装选项,请参见 官方文档

暴露 localhost

在终端中运行以下命令:
请务必为您的本地服务器指定正确的端口。

.env.local 文件中设置 NEXT_PUBLIC_URL 环境变量

使用提供的 URL

cloudflared 会生成一个随机子域名并在终端打印,以供您使用。所有到该 URL 的流量都会被转发到您的本地服务器。 将提供的 URL 输入到 Farcaster Embed 工具 中。 embed-tool 让我们研究一下该模板的各个组成部分。

自定义 Mini App Embed

Mini App Embed 是当应用的 URL 被分享时,Mini App 出现在 feed 或聊天中的方式。 Mini App Embed 看起来像这样: embed-preview 您可以通过编辑文件 app/page.tsx 来自定义它:
app/page.tsx
您可以修改图片的 URL,或替换模板 public/images 文件夹中的图片。 在您满意所做的更改之后,请点击 Embed 工具中的 Refetch 以获取最新配置。
如果您在本地开发,请确保您的 Next.js 应用正在本地运行,且 cloudflare tunnel 处于打开状态。

自定义启动画面

打开 Mini App 时,用户首先看到的是启动画面: splash-screen 您可以编辑 app/page.tsx 文件来自定义启动画面。
app/page.tsx
对于 splashImageUrl,您可以修改 URL,或替换模板 public/images 文件夹中的图片。

修改 Mini App

打开模板 Mini App,您应会看到如下界面: miniapp 该界面的代码位于 components/pages/app.tsx 文件中:
components/pages/app.tsx
您可以移除或编辑此文件中的代码来构建您自己的 Mini App。

访问用户上下文

user-context 您的 Mini App 会接收关于用户的各种信息,包括 usernamefiddisplayNamepfpUrl 等字段。 该模板提供了一个有用的 hook useMiniAppContext,您可以使用它来访问这些字段:
components/Home/User.tsx
模板中也在 components/Home/User.tsx 文件中提供了类似示例。 您可以在 此处 了解更多关于 Context 的信息。

执行 App Actions

Mini Apps 能够执行提升用户体验的原生 actions! 例如:
  • addFrame:允许用户将应用保存(收藏)到一个专门的部分
  • composeCast:允许 Mini App 提示用户使用预填的文本和媒体进行 cast
  • viewProfile:在客户端原生 UI 中展示 Farcaster 用户的个人资料
此处 了解更多关于 Mini App actions 的信息。 该模板提供了通过 useMiniAppContext hook 便捷访问这些 actions 的方式!
components/Home/FarcasterActions.tsx
有关同一功能的示例可以在 components/Home/FarcasterActions.tsx 文件中找到。

触发钱包操作

wallet-actions 每个 Farcaster 用户都有一个支持 Monad 测试网的 Farcaster 钱包。 Mini Apps 可以提示用户执行链上操作! 该模板在 components/Home/WalletActions.tsx 文件中提供了相应示例。
components/Home/WalletActions.tsx
Farcaster 钱包支持多个网络。建议在触发钱包操作之前,确保连接到正确的网络。您可以使用 viem 的 switchChain 或等效方法来提示切换链。
components/Home/WalletActions.tsx
该模板在 components/Home/WalletActions.tsx 文件中包含相应示例。

结语

在本指南中,您了解了 Farcaster Mini Apps —— 创建具有高吸引力、高留存率和易变现应用的最简单方式! 您还了解了 Mini Apps 的关键能力,以及如何使用 Monad Farcaster Mini App 模板 来构建自己的 Mini App。 有关更多详情,请查阅 此处 的官方 Mini App 文档。

探索更多 Farcaster Mini App 指南

发送通知

生成自定义可分享图片

发布 Mini App