Skip to content

README.md

Latest commit

 

History

History
92 lines (57 loc) · 2.69 KB

README.md

File metadata and controls

92 lines (57 loc) · 2.69 KB

🎛️ SyftUI

A slick user interface for SyftBox — your gateway to federated data science magic 🧙‍♂️✨.

SyftUI comes in two flavors:

  1. 🖥️ Desktop App – All-in-one bundle, just download and run!
  2. 🌐 Web App – Lightweight and handy, connects with any SyftBox daemon (local or remote).

🚀 Installation

🖥️ Desktop App (Recommended)

The easiest, most powerful way to run SyftUI.

The SyftBox daemon is already bundled — no extra setup needed!

🌐 Web App (For the Adventurous)

Perfect for headless setups or low-resource environments.

  • Make sure a SyftBox daemon is running (either locally or remotely) — instructions here.
  • Launch the frontend by visiting this link.
  • Enter the Client URL and Token (you’ll find them in your SyftBox client logs).

🛠️ Development

💅 Set Up

✨ One command. All the dependencies. Magic. ✨

just setup

✅ And boom! You’re ready to start building! It’s that simple. 🚀

🖥️ Desktop App (Frontend + Bridge + Desktop)

Work on the frontend, the SyftBox bridge client, AND the Tauri app — all at once with hot reload.

just dev

🌐 Web App (Frontend-Only)

Run the frontend in dev mode.

just dev-frontend

💡 Tip: Don’t forget to manually run the SyftBox client by executing just dev-bridge in a terminal. Then, copy the Client URL and Token from the logs and paste them into the frontend.

🏗️ Build and Package

🖥️ Desktop App

To build and package the desktop app for your current operating system, run:

just package

Depending on your OS, this command will generate the appropriate installer:

  • Windows: .exe installer
  • Linux: .AppImage, .deb, and .rpm packages
  • macOS: .dmg package

🌐 Web App

Build the frontend in SSG (Static Site Generation) mode.

Output: ./out

just package-frontend

And that's it! Now go create something private, powerful, and pretty! 🧠🔒💻