PocketPal AI 安装与配置指南

1. 项目基础介绍

PocketPal AI 是一个可以在手机上运行的口袋式 AI 助手，它基于小型语言模型（SLMs）运行，无需互联网连接即可与用户互动。该项目是为 iOS 和 Android 平台设计的，允许用户在设备上下载和切换不同的 SLMs，如 Danube 2 和 3、Phi、Gemma 2 以及 Qwen。

主要编程语言：TypeScript、JavaScript

2. 项目使用的关键技术和框架

• React Native：用于构建跨平台的移动应用程序。
• Hugging Face：集成 Hugging Face 模型仓库，以便用户可以直接从应用内浏览、下载和运行模型。
• TypeScript：为 JavaScript 提供类型系统和编译时类型检查。
• Yarn：作为 JavaScript 的包管理工具。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始安装之前，请确保你的开发环境中安装了以下工具：

• Node.js（版本 18 或更高）
• Yarn
• React Native CLI
• Xcode（用于 iOS 开发）
• Android Studio（用于 Android 开发）

安装步骤

步骤 1：克隆仓库

首先，你需要从 GitHub 克隆这个项目：

git clone https://github.com/a-ghorbani/pocketpal-ai.git
cd pocketpal-ai

步骤 2：安装依赖

接下来，使用 Yarn 安装项目依赖：

yarn install

步骤 3：安装 iOS Pod 依赖（仅限 iOS）

如果你的目标是 iOS 平台，你需要安装 Pod 依赖：

cd ios
pod install
cd ..

步骤 4：运行应用

根据你的开发目标，可以选择以下方式运行应用：

• iOS 模拟器：

  yarn ios
  

• Android 模拟器：

  yarn android
  

步骤 5：其他脚本

• 启动 Metro Bundler：

  yarn start
  

• 清除构建工件：

  yarn clean
  

• 语法检查和类型检查：

  yarn lint
  yarn typecheck
  

• 运行测试：

  yarn test
  

以上步骤为 PocketPal AI 的基础安装和配置指南，按照这些步骤，你应该能够成功地在本地环境运行该项目。