快速上手开发

提示

本章节只针对开发者和测试人员阅读，普通用户可以跳过此章节。

本指南将引导您在本地环境中设置并运行 KanTime 系统。

源码

您可以通过 Gitea 查看并获取 KanTime 源码，地址是内网地址，只在珠海横琴分部局域网内可访问

环境准备

在开始之前，请确保您的开发环境中已安装以下软件：

• Node.js: v18.x 或更高版本（推荐使用最新 LTS 版本）
• Python: v3.10 或更高版本（推荐使用最新 LTS 版本）
• Docker 和 Docker Compose (用于运行数据库和 Vault 以及前后端)

数据库 PostgreSQL 以及 HashiCorp Vault 搭建

KanTime 使用 PostgreSQL 作为主要数据库，并使用 HashiCorp Vault 来管理敏感信息（如加密密钥）

搭建 PostgreSQL：

docker run --name kantime-db-dev --restart unless-stopped -e POSTGRES_USER=kantime -e POSTGRES_PASSWORD=password -e POSTGRES_DB=kantime_db -p 5432:5432 -d postgres:latest

搭建 HashiCorp Vault：

docker run --name vault-dev --restart unless-stopped --cap-add=IPC_LOCK -e VAULT_DEV_ROOT_TOKEN_ID=myroot -e VAULT_DEV_LISTEN_ADDRESS=0.0.0.0:8200 -p 8200:8200 -d hashicorp/vault:latest server -dev -dev-root-token-id=myroot -dev-listen-address=0.0.0.0:8200

在搭建 HashiCorp Vault 后，进入到 Vault 容器里面

启用 transit secrets engine

vault secrets enable transit

创建加密密钥

vault write -f transit/keys/my-dev-key

后端 (kantime-core) 启动步骤

1. 创建并激活 Python 虚拟环境

   # 进入后端目录
   cd kantime-core
   
   # 创建虚拟环境
   python -m venv .venv
   
   # 激活虚拟环境 (Windows)
   .venv\Scripts\activate
   
   # 激活虚拟环境 (macOS/Linux)
   source .venv/bin/activate

2. 安装依赖

   pip install -r requirements.txt

3. 配置环境变量

   复制 .env.example 文件为 .env，并根据您的本地环境进行必要的修改

4. 运行数据库迁移

   初次运行时，需要创建数据库表结构

   alembic upgrade head

   user_service 会在应用启动时自动创建初始数据（如角色、权限、管理员账户等）

5. 启动后端服务

   uvicorn app.main:app --reload

   服务启动后，您可以在 http://127.0.0.1:8000/docs 访问 API 文档。

前端 (kantime-web) 启动步骤

1. 进入前端目录

   cd kantime-web

2. 安装依赖

   npm install

3. 启动开发服务器

   npm run dev

   服务启动后，您可以在浏览器中打开 http://localhost:5173 访问 KanTime 系统。

初始登录

系统初始化后，会自动创建一个管理员账户：

• 用户名: admin
• 密码: password

使用此账户登录后，您可以开始创建其他用户和项目。