The drifty from kavyarishi19

About 🔥

Drifty is an open-source interactive File Downloader system built using Java.
It is both available in Command Line Interface (CLI) and Graphical User Interface (GUI) mode.

Demo

See the video below to know how to use the application. For any help, you can open an issue.

For Batch Downloading via Drifty CLI, the path to a YAML file has to be provided to it. It should have the following structure :

links: ["", ""] # [REQUIRED] - Links to the files to be downloaded
# Below parameters are OPTIONAL
fileNames: [""] # Will be auto-retrieved if not provided
# If the directory is not provided, the files will be downloaded in the default downloads folder.
directory: [""] # Use 'directory' when all the files to be downloaded in the same folder.
directories: [""] # Use 'directories' when the download folder is different for each of the files

Drifty GUI

GUI.mp4

Drifty CLI

CLI.mp4

Tech Stack

The Application Drifty is built using the following technologies :

Java - A programming language for building machine independent applications.

The Website of Drifty is built using the following technologies :

Next.js - A JavaScript framework for building server-rendered React applications.
Tailwind CSS - A utility-first CSS framework.

Quickstart 🚀🚀

For Users :

Using Drifty Application executable

Open the website of Drifty
Click on Download
At first, select the Application Type from the Dropdown menu (By default, it is GUI). For downloading Drifty CLI, select CLI and for Drifty GUI, select GUI from the dropdown menu. Click on the Download Now button based on your Operating System (Windows, Linux, MacOS). For Windows user, a MSI file is available for Drifty GUI. You can click on the Prefer the msi? text and it will download the latest MSI file for you 🎉!.
Go to your Downloads folder and run the file you downloaded.

[!NOTE]
Follow the on-screen instructions (For PKG and MSI files) for setting up Drifty GUI.
See Demo for demonstrations on how to use the application.
Leave a star on GitHub if you liked the project.
For any issues or feature requests, you may discuss that on our Discord Server.

Using Drifty Application via Docker 🐋

Important

To download files in your local directory, you need to pass that directory as a volume to Drifty.
Suppose, you want to download the file in your home/username/Downloads directory, then, the volume flag that you need to pass to docker will be -v /home/username/Downloads:/root/Downloads.
You can pass -v /home/username/.drifty:/root/.config to enable the docker container to store the Drifty's data in your local directory, making initialization of Drifty much faster 🚀.
For Linux, it is advisable to use Docker Engine directly instead of running images using Docker Desktop. You can do the same by adding sudo before the docker commands.

Pull the Docker image for Drifty using the below command -
For Drifty CLI,

docker pull ghcr.io/saptarshisarkar12/drifty-cli:master

For Drifty GUI,

docker pull ghcr.io/saptarshisarkar12/drifty-gui:master

Run the docker image using the below command -
For Drifty CLI,
```
docker run ghcr.io/saptarshisarkar12/drifty-cli:master
```
For Drifty GUI,
```
docker run -e DISPLAY=$DISPLAY --net=host ghcr.io/saptarshisarkar12/drifty-gui:master
```
[!IMPORTANT]
For Linux and Windows, please run xhost +local:docker before running the GUI docker image.
For macOS, please follow this article to run GUI docker images.
Drifty will open, and you can now use it 🎉!

For Contributors :

Go to the project link on GitHub, fork this repository and clone your fork into your local directory by running this command in your terminal.
```
git clone [email protected]:SaptarshiSarkar12/Drifty.git
```
Open an issue ❕ describing the changes you want to make.
Make the changes in an IDE (preferably Intellij Idea) and open a Pull Request. Ensure that you have linked the issue to the Pull Request.
The Pull Request will be reviewed by the maintainers and merged if approved. ✔
Leave a star ⭐ on GitHub if you liked the project.
You may join our Discord Server to discuss on the changes that you want to bring.

Using Docker 🐋 for Development

Run docker compose run gui to start Drifty GUI and docker compose run cli to start Drifty CLI. The CLI and GUI will be built using your changed source code.

[!IMPORTANT]
For Linux and Windows, please run xhost +local:docker before running the GUI docker image.
For macOS, please follow this article to run GUI docker images.
Drifty app will appear on the screen and you can test it 🎉!

Safety warning ⚠️ while Downloading ⬇️

It is because Microsoft Defender could not verify it is safe as it is not commonly downloaded. Feel free to proceed with the following steps:

Click on the three dots.
Click on keep.

Click Show More.
Click Keep anyway.

Now its downloaded, you can proceed.🎉

Report the file as safe ✔️

You can also provide your feedback to Microsoft Defender by reporting it to be Safe, by following following steps:

Click on three dots.
Click on Report this file as safe instead of clicking on Keep.

It will take you to Report a download page. You can provide your feedback there.😄

Safety warning ⚠️ while Installing

For Windows, click on More Info and then Run Anyway as present in the screen below :
For macOS, click on Ok and run sudo spctl --master-disable in your terminal to allow running unsigned apps. Try running Drifty again.

Contributing to the project

Please feel free to contribute to this open-source project.
See Contribuing Guidelines and Projects for ways to contribute.
Feel free to open an issue.
Please adhere to this project's Code Of Conduct.
Remember, this project follows Semantic Versioning for the releases.
Join our Discord Server to get updates on this project and discuss verbosely on the changes that you want to make.

Stats 📊

Support 🙏

Please leave a star ⭐ on this project to support us.

kavyarishi19 / drifty Goto Github PK

drifty's Introduction