Traq 项目技术文档

1. 安装指南

环境要求

• PHP 8.1 及以上版本
• MariaDB 或 MySQL 数据库
• Apache 的 mod_rewrite 模块（或服务器配置为使用 index.php 作为 404 页面）
  • 将 htaccess.txt 重命名为 .htaccess，或找到适用于你服务器的 .htaccess 文件

安装步骤

1. 将 Traq 项目上传到服务器。
2. 在浏览器中打开项目的 URL。
3. 按照安装向导的步骤完成安装。

2. 项目的使用说明

Traq 是一个由 PHP 驱动的项目管理工具，能够跟踪多个项目的多个里程碑的进度。它提供了以下主要功能：

• 问题跟踪：可以为每个项目创建和管理问题，跟踪问题的状态和进度。
• 里程碑管理：为项目设置里程碑，并跟踪每个里程碑的完成情况。
• 多项目支持：支持同时管理多个项目，每个项目可以有独立的问题和里程碑。

使用步骤

1. 登录 Traq 系统。
2. 创建新项目或选择现有项目。
3. 在项目中创建问题或里程碑，并进行管理。

3. 项目API使用文档

Traq 提供了丰富的 API 接口，允许开发者通过编程方式与项目进行交互。以下是一些常用的 API 接口：

获取项目列表

GET /api/projects

返回所有项目的列表。

创建新项目

POST /api/projects

请求体：

{
  "name": "项目名称",
  "description": "项目描述"
}

创建一个新的项目。

获取问题列表

GET /api/projects/{project_id}/issues

返回指定项目的所有问题列表。

创建新问题

POST /api/projects/{project_id}/issues

请求体：

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

在指定项目中创建一个新问题。

4. 项目安装方式

克隆仓库

首先，克隆 Traq 项目的 Git 仓库：

git clone https://github.com/nirix/traq.git

初始化子模块

Traq 依赖于 Avalon 框架，因此需要初始化并更新子模块：

git submodule init
git submodule update

安装依赖

使用 npm 安装项目依赖：

npm install

构建 UI

构建用户界面：

npm run build

完成以上步骤后，Traq 项目即可部署到服务器上，并通过浏览器访问进行安装和使用。