SDK and App Builder Guide
This page is the single start point for developers who want to build apps on VX6. Backend maintainers keep VX6 runtime behavior stable. UI teams build platform-specific experiences on top of that backend.
1. Core idea
- Do not reimplement protocol logic in each UI.
- Use shared backend (`vx6d`) as your app-facing runtime contract.
- Build platform UI separately: Tauri, Android, iOS, Web.
2. Start the shared backend
go build -o vx6d ./apps/vx6backend/cmd/vx6d
./vx6d --listen 127.0.0.1:4866
curl -fsS http://127.0.0.1:4866/healthOnce `vx6d` is running, your UI calls local endpoints instead of shelling raw commands.
3. API actions your UI should map
- Node lifecycle: init, start, stop, status.
- General command bridge: peer/service/list/DHT operations.
- Chat send endpoint for message workflow integration.
Contract reference: apps/vx6backend/API.md
4. Platform folders and responsibilities
Tauri (Desktop)
Focus on UX, session controls, chat/service actions, and runtime logs panel.
Android
Build mobile UI and bridge actions to same backend behavior and message flow.
iOS
Mirror Android functional behavior while keeping iOS-native UX and permissions.
Web/Other Desktop UI
Consume local backend contract and keep protocol logic out of frontend code.
5. Suggested developer workflow
Pick one scope
Backend endpoint, one UI feature, or one platform integration issue.
Implement with backend-first contract
Keep behavior aligned with `vx6d` and update API docs if contract changes.
Validate and submit
Share test/build evidence and screenshots for UI contributions.