jjraderftw / drifty Goto Github PK

• 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.

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

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.

For Users :

1. Visit the Drifty website
   
2. Click on Download
   
3. Choose the Application Type from the dropdown menu (Default option is GUI). To download Drifty CLI, select CLI and to download Drifty GUI, select GUI. Then, click on the Download Now button based on your Operating System (Windows, Linux, macOS). For Windows user, there is an MSI file available for Drifty GUI. You can click on the Prefer the msi? text to download the latest MSI file. 🎉
   
4. Navigate to the Downloads folder and execute the downloaded file. If you are installing Drifty GUI, complete the steps in the macOS or Windows MSI installer wizard that appears on your screen.
5. Check out the Demo section for examples of how to use the application.
6. If you like the project, please leave a star on GitHub.
7. For any issues or feature requests, you can join our Discord Server and share your feedback.

1. 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

2. 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

3. Drifty will open, and you can now use it 🎉!

For Contributors :

1. 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

   

2. Open an issue ❕ describing the changes you want to make.

3. 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.
4. The Pull Request will be reviewed by the maintainers and merged if approved. ✔

5. Leave a star ⭐ on GitHub if you liked the project.
   
6. You may join our Discord Server to discuss on the changes that you want to bring.

1. To start Drifty GUI and Drifty CLI with your modified source code, run docker compose run gui and docker compose run cli respectively.
2. The Drifty app will show up on the screen, and you can test it 🎉!

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 it is downloaded, you can proceed.🎉

You can also provide your feedback to Microsoft Defender by reporting it to be Safe, by following the below 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.😄

• 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.
  

• We welcome 🤝 your contributions to this Open-Source project.
• Please check the Contributing Guidelines and the Roadmaps for ways to get involved.
• You can also open an issue to report a bug 🐛, request a feature 💡, or suggest an improvement 📈.
• Please follow this project's Code Of Conduct to maintain a respectful and inclusive environment.
• Please note that this project uses Semantic Versioning for its releases.
• Join our Discord Server to stay updated on this project and chat 💬 with the maintainer and the other contributors.

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