LifeTrace

English

简体中文

English

简体中文

Appearance

LifeTrace Installation Guide ​

Want to get started with LifeTrace quickly? Check out Quick Start Guide 🚀 ​

System Requirements ​

Before installing LifeTrace, please ensure your system meets the following requirements:

Operating System ​

  • Windows 10/11
  • macOS 10.14+

Software Dependencies ​

  • Python 3.13+
  • Git (for cloning repository)

Hardware Requirements ​

  • Memory: 4GB or more recommended
  • Hard Disk: At least 10GB available space (for storing screenshots and database)
  • Processor: Multi-core processor supported
  • Optional: CUDA support (for GPU acceleration)

Installation Steps ​

1. Clone Project Repository ​

First, clone the LifeTrace project from GitHub:

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

2. Install Dependencies ​

This project uses uv for fast and reliable dependency management.

First, install uv if you haven't already:

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

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

Then, install project dependencies:

bash
# Sync dependencies from pyproject.toml and uv.lock
uv sync
# Activate virtual environment
# macOS
source .venv/bin/activate

# Windows
.venv\Scripts\activate

Main dependencies include:

  • FastAPI - Web framework
  • RapidOCR - OCR recognition engine
  • ChromaDB - Vector database
  • Pillow - Image processing
  • mss - Screenshot tool
  • Multimodal models - For advanced search capabilities

3. Start Services ​

Start Backend Service ​

First Time Setup: On first run, if config.yaml does not exist, the system will automatically copy it from default_config.yaml. You can customize settings by editing lifetrace/config/config.yaml.

Start the server:

bash
python -m lifetrace.server

Customize Prompts: To modify AI prompts for different features, edit the YAML files in the lifetrace/config/prompts/ directory.

Start Frontend Service ​

The frontend is required to use LifeTrace. Start the frontend development server:

bash
cd frontend
pnpm install
pnpm dev

The frontend development server will start at http://localhost:3000, and API requests will be automatically proxied to the backend at port 8000.

4. Start Using ​

Once both services are running, open your browser and visit http://localhost:3000 to start using LifeTrace! 🎉

Next Steps ​

After installation, please see Usage Guide to learn how to use LifeTrace.