https://github.com/miloua91/clipwarp
Clipboard/Links manager.
https://github.com/miloua91/clipwarp
clipboard-manager link-manager
Last synced: over 1 year ago
JSON representation
Clipboard/Links manager.
- Host: GitHub
- URL: https://github.com/miloua91/clipwarp
- Owner: Miloua91
- Created: 2024-02-16T15:58:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T22:17:55.000Z (about 2 years ago)
- Last Synced: 2024-05-22T18:56:02.768Z (about 2 years ago)
- Topics: clipboard-manager, link-manager
- Language: Python
- Homepage:
- Size: 11.2 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ClipWarp
[![product-screenshot]](https://clipwarp.vercel.app)
## Elevator pitch
Ever get frustrated trying to share links or text between your desktop and phone? It's a common inconvenience we all face. You have a link on your desktop, therefore you'd think it would be easy to get it on your phone, but it's always more complicated than it should be.
That's where ClipWarp comes in. Install it on both devices, and you’ll have a simple way to manage links and text across platforms without the extra steps.
![example-screenshot]
An instance where you need to send a link to your device, screenshot from Expo documentation. If it's up to me, then I will definitely use ClipWarp.
## Installation
### Windows 10/11
1. Download [clipwarp-0.1.0.exe](https://github.com/Miloua91/clipwarp/releases/download/v0.1.0/clipwarp-0.1.0.exe).
2. Install the app.
3. Launch it.
### Linux (x64)
#### Tarball
1. Download [clipwarp-0.1.0.tar.gz](https://github.com/Miloua91/clipwarp/releases/download/v0.1.0/clipwarp-0.1.0.tar.gz).
2. Extract it:
```sh
tar xzvf clipwarp-0.1.0.tar.gz
```
3. Create an assets directory:
```sh
mkdir ~/.config/clipwarp/assets
```
4. Run the app:
```sh
./clipwarp/ClipWarp
```
#### Arch Linux
1. Download the [PKGBUILD](https://github.com/Miloua91/clipwarp/releases/download/v0.1.0/PKGBUILD).
2. Install the app:
```sh
makepkg -si
```
3. Launch the app:
```sh
clipwarp
```
### Android
1. Download the [APK file](https://github.com/Miloua91/clipwarp/releases/download/v0.1.0/clipwarp-1.0.0.apk).
2. Install it on your device.
3. Launch the app.
## Get the source code
Clone the repository:
```sh
git clone https://github.com/Miloua91/clipwarp.git
```
### Desktop App
1. Go to the `desktop-app` directory:
```sh
cd clipwarp/desktop-app
```
2. Create a Python Virtual Environment:
- Using [virtualenv](https://pypi.org/project/virtualenv/):
_Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
```bash
virtualenv env
```
**OR**
- Create a Python Virtual Environment:
```bash
python -m venv env .
```
3. Activate the Virtual Environment.
- On Windows.
```bash
env\Scripts\activate
```
- On macOS and Linux.
```bash
source env/bin/activate
```
4. Install the required Python packages:
```sh
pip install -r requirements.txt
```
5. Launch the app:
```sh
python main.py
```
Currently the project is being developed using Python 3.13
#### Build the Desktop App with PyInstaller
1. With [PyInstaller](https://pypi.org/project/pyinstaller/): build the app on desktop
_Note_: Check how to use PyInstaller on your system here [link](https://pyinstaller.org/en/v4.1/usage.html).
```
pyinstaller main.spec
```
2. Launch the app
```
./dist/ClipWarp
```
### Mobile App
1. Go to the `mobile-app` directory:
```sh
cd clipwarp/mobile-app
```
2. Install the packages:
```sh
yarn install
```
3. Start the development server:
```sh
yarn expo start
```
#### Build the Mobile App
1. Install EAS CLI if you don't have it:
```sh
npm install --global eas-cli
```
2. Build the app:
```sh
eas build -p android --profile preview
```
### Web App
1. Go to the `web-app` directory:
```sh
cd clipwarp/web-app
```
2. Install the packages:
```sh
npm install
```
3. Start the server:
```sh
npm run dev
```
#### Build the Web App
1. Build the app:
```sh
npm run build
```
[product-screenshot]: ./presentation.png
[example-screenshot]: ./example.png