---
title: API 接口
description: 用于设置 WealthMentor 本地安装的指南。
icon: "gear"
---

本文旨在指导您完成在本地安装 WealthMentor 的过程。重要的是要注意，我们建议使用 Docker 进行此安装。Docker 简化了该过程，并确保所有依赖项都得到正确处理，使安装过程更加简单和不易出错。

## 先决条件

在开始之前，请确保您已安装以下内容：

1. [Git](https://git-scm.com/downloads)
2. [Node.js](https://nodejs.org/en/download)
3. [OpenAI API 密钥](https://beta.openai.com/signup/)
4. 任意您选择的代码编辑器，如 [Visual Studio Code (VS Code)](https://code.visualstudio.com/download)

### Docker 安装（推荐）

除了上述先决条件外，还需要 Docker 进行此设置。按照以下步骤进行 Docker 安装：

1. 下载并安装 [Docker](https://www.docker.com/products/docker-desktop)
2. 安装完成后，如果尚未拥有 Docker 帐户，则创建一个
3. 打开 Docker Desktop 应用并登录

## 使用 Docker 安装

1. **打开您的编辑器**

2. **打开终端** - 通常可以在“终端”选项卡中执行此操作，也可以使用快捷键
   （例如，在 VS Code 中，Windows 为 `Ctrl + ~`，Mac 为 `Control + ~`）。

3. **克隆存储库并进入目录** - 终端打开后，可以运行以下命令来克隆存储库并进入目录。



4. **按照脚本的设置说明操作** - 添加适当的 API 密钥，一旦所有服务都运行起来，就打开您的 Web 浏览器前往 [http://localhost:3000](http://localhost:3000)。

## 不使用 Docker 安装

在 Docker 外部，您只需配置您的环境。此外，您可以使用 `setup.sh` 配置您的环境并更新 Prisma 配置以指向本地 SQLite 实例。

完成此操作后，您可以运行以下命令来设置 Next.js 项目。

```bash
// 前端
cd ./next
npm install
npm run dev
```

在另一个窗口中，您可以运行以下命令来启动后端：

```bash
// 后端。确保您位于项目的根目录
cd ./platform
poetry install
poetry run python -m reworkd_platform
```

## 运行站点

恭喜您成功在本地计算机上设置了 WealthMentor！要查看您的工作成果，请打开您首选的 Web 浏览器，并访问 [http://localhost:3000/](http://localhost:3000/)。在那里，您会发现 WealthMentor 用户界面已准备好供您探索和交互。

## 问题 / 额外帮助

尽管有详细的说明，但您可能仍然会遇到一些问题。如果发生这种情况，不用担心！我们会帮助您。考虑参考此详细的旧版指南，它会为您提供详细的步骤：[如何在本地安装 WealthMentor](https://snapdragon-writer-867.notion.site/How-to-Install-WealthMentor-Locally-9b96b2314c9b491397976249fd121023)。

如果问题仍然存在，我们邀请您在 GitHub 上提交一个 [问题](https://github.com/reworkd/WealthMentor/issues)。通过这样做，您不仅会得到帮助，还会帮助我们识别任何可能存在问题的地方以加以改进。或者，您可以在 [Discord](https://discord.gg/jdSBAnmdnY) 上联系我们专注的团队。我们是一个学习者和爱好者的社区，随时准备伸出援手。

祝您愉快地编程，并享受与 WealthMentor 的旅程！