Skip to content

⚡ 快速上手 FreeTodo ⚡

1. 克隆项目仓库

首先,从 GitHub 克隆 FreeTodo 项目:

bash
git clone https://github.com/FreeU-group/FreeTodo.git
cd FreeTodo

2. 安装依赖包

本项目使用 uv 进行快速可靠的依赖管理。

首先,安装 uv(如果尚未安装):

bash
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

注意:安装完成后,uv 可能无法在当前终端中立即使用。要在当前会话中激活它:

  • Windows (PowerShell):运行 $env:Path = "$env:USERPROFILE\.local\bin;$env:Path" 来刷新 PATH
  • macOS/Linux:运行 exec $SHELL 来重新初始化 shell 会话,或重新打开终端

或者,您也可以直接打开一个新的终端窗口,uv 将自动可用。

然后,在项目根目录下,安装项目依赖:

bash
# 从 pyproject.toml 和 uv.lock 同步依赖
uv sync

# 激活虚拟环境
# macOS/Linux
source .venv/bin/activate

# Windows
.venv\Scripts\activate

3. 启动服务

启动后端服务

在项目根目录下,启动服务器:

bash
python -m lifetrace.server

后端服务会自动从 8001 端口开始查找可用端口,实际端口会在控制台显示。

启动前端服务

前端是使用 FreeTodo 的必需组件。启动前端开发服务器:

bash
cd free-todo-frontend

pnpm install
pnpm dev

前端开发服务器会自动从 3001 端口开始查找可用端口,并自动检测后端端口。

4. 开始使用

两个服务都启动后,打开浏览器并访问控制台显示的前端地址(通常为 http://localhost:3001)开始使用 FreeTodo!🎉