Skip to content

Latest commit

 

History

History

README.md

Cross-platform desktop application for editing Quilt data packages

QuiltSync keeps your data under revision control and never asks you to think about it.

Built for bench scientists rather than engineers, QuiltSync lets you find a data package in the Quilt Web Catalog, open it on your desktop, and bring down only the files you need — not the whole package — into an ordinary local folder.

Edit them in your usual tools and QuiltSync syncs your changes back as a new revision, so getting data in and out never means the command line or uploading file copies through the browser.

Every revision is an immutable, reproducible snapshot with its metadata — versioned data you can trust and return to, not the opaque mirroring of ordinary file-sync.

Your team's existing rules still apply: each revision conforms to the workflow configured for its bucket and reuses the same roles and policies you already have in the Catalog — nothing new to set up.

Usage

From the repository root:

npm install
npm start

Testing deep linking on macOS

NOTE: macOS does not support dynamic deep linking. You need to build the app and copy it to the Applications folder to test the deep linking feature.

npm run build # building dmg will fail
sudo cp -rf src-tauri/target/release/bundle/macos/QuiltSync.app ~/Applications
open ~/Applications/QuiltSync.app

Repository Contents

src: Static Web Frontend

This is the actual user interface presented by the application.

  • index.html
  • web assets
  • styles.css

src-tauri: Rust Backend

  • Cargo.toml
  • src/main.rs
  • tauri.conf.json
  • icons (for app icon)
  • target (for output)

Development

npm install typescript -g  # if `tsc` is not installed (need for git pre-commit)
cargo install cargo-watch  # only do once
RUST_BACKTRACE=1 cargo watch -C src-tauri  # -x test

parcel watch and "Safe write"

parcel watch can fail on saving files if "Safe Write" is enabled in your IDE.

Learn more at https://parceljs.org/features/development/#safe-write.

Auto Updater

QuiltSync automatically checks for updates on startup and prompts users when new versions are available.

Contributing

For maintainers and contributors, see CONTRIBUTING.md for testing procedures, release processes, and development workflows.