Plane 项目技术文档

Plane 项目技术文档

plane-mobile 📱 🛫 🔥 Mobile App of Plane. Open Source JIRA, Linear and Height Alternative. Plane helps you track your issues, epics, and product roadmaps in the simplest way possible. 项目地址: https://gitcode.com/gh_mirrors/pl/plane-mobile

安装指南

1. 安装所需工具

对于 Windows 用户：

• 安装 JDK（Java Development Kit）
• 安装 Flutter SDK
• 安装 Dart SDK
• 安装 Android Studio

详细安装步骤请参考 Flutter 官方文档。

对于 macOS 用户：

• 安装 Xcode
• 安装 Homebrew
• 安装 JDK
• 安装 Flutter
• 安装 Dart
• 安装 Cocoapods

详细安装步骤请参考 Flutter 官方文档。

2. 克隆代码库

• 使用 Git 克隆 Plane 项目代码库到本地。

3. 创建 .env 文件

1. 在项目根目录下创建一个名为 .env 的文件。
2. 在 .env 文件中定义变量 BASE_API（必需）和 UNSPLASH_API_KEY（可选），并初始化它们。

项目使用说明

功能概述

• 问题规划与跟踪：快速创建问题并使用支持文件上传的富文本编辑器添加详细信息。为问题添加子属性和引用，以便更好地组织和跟踪。
• 布局：根据您的偏好自定义项目视图，选择列表、看板或日历布局，以最适合您的方式可视化项目。
• 周期：使用周期规划冲刺，保持团队进度和生产力。通过燃尽图和其他有用功能了解项目进展。
• 模块：将大型项目分解为更小、更易管理的模块。在团队之间分配模块，以便轻松跟踪和规划项目进度。

截图展示

• 问题视图
• 问题详情
• 周期视图
• 模块视图

项目 API 使用文档

API 概述

Plane 项目提供了一系列 API 接口，用于与项目进行交互。以下是一些常用的 API 接口：

1. 获取项目列表

GET /api/projects

2. 创建新问题

POST /api/issues

请求体示例：

{
  "title": "问题标题",
  "description": "问题描述"
}

3. 更新问题

PUT /api/issues/{issue_id}

请求体示例：

{
  "title": "更新后的标题",
  "description": "更新后的描述"
}

4. 删除问题

DELETE /api/issues/{issue_id}

项目安装方式

1. 克隆代码库

使用 Git 克隆 Plane 项目代码库到本地：

git clone https://github.com/makeplane/plane.git

2. 安装依赖

进入项目目录并安装所需的依赖：

cd plane
flutter pub get

3. 运行项目

在安装完所有依赖后，使用以下命令运行项目：

flutter run

通过以上步骤，您可以成功安装并运行 Plane 项目。如果在使用过程中遇到任何问题，请参考官方文档或加入社区寻求帮助。

plane-mobile 📱 🛫 🔥 Mobile App of Plane. Open Source JIRA, Linear and Height Alternative. Plane helps you track your issues, epics, and product roadmaps in the simplest way possible. 项目地址: https://gitcode.com/gh_mirrors/pl/plane-mobile