Skip to content

Latest commit

 

History

History
105 lines (83 loc) · 3.33 KB

readme.md

File metadata and controls

105 lines (83 loc) · 3.33 KB

Z-Touch

Z-Touch is a cross-platform project organization tool that enables efficient tagging and searching of local projects and links.

Features

  • Tag and organize projects from the local filesystem or via a web link
  • Advanced search and filtering capabilities
  • Cross-platform support (Windows, Mac, and Linux)
  • Lightweight and fast

Screenshots

UI
Edit project
Tag autocomplete
Reorder projects
Select file dialog

Tech Stack

Z-Touch is a GUI application built with Zig and WebView. The frontend is built with Solid and Tailwind.

Installation

Pre-built binaries

Z-Touch can be downloaded from the releases page. NOTE FOR MACOS USERS: The pre-built binaries are not signed. After moving the app to your Applications folder, you will need to run the following command:

xattr -cr /Applications/Z-touch.app

If you do not want to do this, you will have to build the app from source.

Build from source

To build Z-Touch from source, you will need to install the Zig programming language and the Bun package manager.

Once you have installed Zig and Bun, you can clone the repository and run the following commands:

git clone https://github.com/max-legrand/z-touch.git

You will then need to update the git submodules and pull their contents:

cd z-touch
git submodule update --init --recursive

Now you can build the application by running the following command:

zig build

Optionally, you can build in release mode with one of three options:

zig build --release=fast   # Optimized for speed
zig build --release=safe   # Optimized for memory safety
zig build --release=small  # Optimized for size

The builds in the releases page are built with the release-fast option.

To build the project as a bundled application, you can run the following command:

Windows:

zig build --release=fast -Dbundle=true

Mac:

zig build --release=fast
zig build bundle-mac

Roadmap

This project in it's current form is a Minimum Viable Product (MVP). There are still several features that I would like to add in the future:

  • Update the MacOS codesigning.
  • Add the tags to the SQLite database.
  • Clean up the UI, I'm not a designer...
  • Since the database is a SQLite database, I would like to add the ability to automatically backup the database either using Git or a cloud sync service.
  • Better support for Linux

Contributing

If you would like to contribute to Z-Touch, please feel free to submit a pull request or open an issue on the GitHub repository.

Acknowledgements

Icons courtesy of