Skip to content

Latest commit

 

History

History

README.md

dpc-client

Desktop application: Python backend (core/) + Tauri/SvelteKit frontend (ui/). This directory is the developer entrypoint — end-user setup lives in ../QUICK_START.md.

License: GPL v3 — see ../LICENSE.md


Prerequisites

AI provider is configured at runtime in ~/.dpc/providers.json, not at install time — see ../docs/CONFIGURATION.md. Options include remote providers (Anthropic, OpenAI, Z.AI, Gemini, GigaChat, GitHub Models) and Ollama for local models.


Run in dev mode

Two processes. Open two terminals.

Backend

cd dpc-client/core
uv sync
uv run python run_service.py

On first run the backend creates identity + config files under ~/.dpc/ (see docs/QUICK_START.md for the file list and docs/CONFIGURATION.md for the full reference).

Frontend

cd dpc-client/ui
npm install
npm run tauri dev

The frontend talks to the backend over WebSocket at 127.0.0.1:9999 by default (override in ~/.dpc/config.ini under [api] port).


Build for distribution

cd dpc-client/ui
npm run tauri build

Artifacts land in ui/src-tauri/target/release/ (plus bundle/msi/, bundle/dmg/, bundle/appimage/ depending on platform).


Test

cd dpc-client/core
uv run pytest
uv run pytest --cov=dpc_client_core

Frontend tests (where they exist) live in ui/ — run npm test there.


Where to look next

Question Doc
How do I install and start using it as a user? ../QUICK_START.md
What goes in ~/.dpc/? ../docs/CONFIGURATION.md
How does the embedded agent work? ../docs/agent/DPC_AGENT_GUIDE.md
How do I deploy with a Federation Hub? ../docs/WEBRTC_SETUP_GUIDE.md
How does the knowledge commit system work? ../docs/KNOWLEDGE_ARCHITECTURE.md
What's in the Python backend package? core/README.md
What does the wire protocol look like? ../specs/dptp_v1.md
How do the three of us (Mike + CC + Ark) work? ../protocol-13-public.md
Where's the project going? ../ROADMAP.md