ClipRust is a clipboard manager application that is designed to enhance the functionality of the system clipboard. It is built using Tauri, a framework for building lightweight, secure, and cross-platform desktop applications with web technologies, and TypeScript, a statically typed superset of JavaScript that adds optional types.
ClipRust is used for managing clipboard data. It allows users to copy and delete clipboard items, and it displays notifications to inform users when an action has been performed. This makes it easier for users to keep track of their clipboard history and manage their copied items.
To use ClipRust, you first need to install it on your machine. The installation process involves cloning the repository, navigating into the project directory, installing the dependencies, and building the Tauri application. Once installed, you can start the application by running the Tauri development server.
Here are the steps to install and use ClipRust:
- Clone the repository:
git clone https://github.com/milinbhakta/ClipRust.git - Navigate into the project directory:
cd ClipRust - Install the dependencies:
npm install - Build the Tauri application:
npm run tauri build - Start the application:
npm run tauri dev
Once the application is running, you can copy and delete clipboard items using the user interface.
The system clipboard typically only allows for one item to be stored at a time. This can be limiting when you need to copy and paste multiple items frequently. ClipRust solves this problem by providing a clipboard manager that allows for multiple items to be stored and managed. This can greatly improve productivity and efficiency when working with copied data.
src/: Contains the TypeScript source files and assets for the frontend of the application.src-tauri/: Contains the Rust source files for the backend of the application.vite.config.ts: Configuration file for Vite, which is used for bundling the frontend code.tsconfig.json: Configuration file for TypeScript..env: Contains environment variables for the project. This file is ignored by Git for security reasons..env.sample: A template for the.envfile. You can copy this file to.envand fill in your own values.iconGenerator.py: A Script to generate icons for different OS and sizes
To start the development server, run npm run tauri dev. This will start the Tauri development server and open the Tauri window.
Contributions are welcome! Please read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.
This project is licensed under the MIT License - see the LICENSE file for details.