Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added Markdown files for Documentation #378

Merged
merged 44 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
d4eea1d
[add]: docs/Quickstart guide to get the user started
hasnainmakada-99 Nov 28, 2023
4d7c042
[add]: Getting-Started.md to help users install drifty on various OS
hasnainmakada-99 Nov 28, 2023
cd7abfa
[add]: Drifty Demo video
hasnainmakada-99 Nov 28, 2023
61ae360
[add]: Dirfty Explanations
hasnainmakada-99 Nov 28, 2023
52ca30a
[add]: FAQ Docs for better troubleshooting of the project for the end…
hasnainmakada-99 Dec 12, 2023
0faf709
Merge branch 'master' into master
SaptarshiSarkar12 Dec 12, 2023
783f061
[fix]: Linter errors in Quickstart.md
hasnainmakada-99 Dec 12, 2023
361e1da
Merge branch 'master' of https://github.com/hasnainmakada-99/Drifty
hasnainmakada-99 Dec 12, 2023
f7b8e21
[fix]: linters on line 17 of quickstart.md
hasnainmakada-99 Dec 12, 2023
b740738
Merge branch 'master' into master
SaptarshiSarkar12 Dec 12, 2023
db37382
[add]: Project(s) Contribution Guide
hasnainmakada-99 Dec 25, 2023
99a5ac5
Merge branch 'master' of https://github.com/hasnainmakada-99/Drifty
hasnainmakada-99 Dec 25, 2023
b232477
Merge branch 'master' into master
SaptarshiSarkar12 Dec 25, 2023
7b8dc5f
update: Contribution as well as the quickstart guide to go for review
hasnainmakada-99 Jan 22, 2024
ea52319
Merge branch 'master' into master
SaptarshiSarkar12 Jan 25, 2024
343a125
Update: Website/app/docs/Quickstart.md
hasnainmakada-99 Jan 26, 2024
173f196
Fixed Typo
hasnainmakada-99 Jan 28, 2024
6ca9b95
Fixed Typos by Saptershi
hasnainmakada-99 Jan 28, 2024
2d481a7
Merge branch 'master' into master
SaptarshiSarkar12 Feb 13, 2024
becf18b
docs: Updated Installation Video in Quickstart
SaptarshiSarkar12 Feb 13, 2024
81fa019
Update Website/app/docs/Contribution.md
hasnainmakada-99 Feb 16, 2024
6baba37
Update Website/app/docs/Contribution.md
hasnainmakada-99 Feb 16, 2024
7d4a320
Update Website/app/docs/Contribution.md
hasnainmakada-99 Feb 16, 2024
2b20e52
Merge branch 'master' into master
SaptarshiSarkar12 Apr 18, 2024
e46b4d9
Merge branch 'master' into master
SaptarshiSarkar12 Apr 27, 2024
4a762a8
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 May 8, 2024
1c1e103
docs: Refactored some lines in the FAQ and Contributing files
SaptarshiSarkar12 May 9, 2024
99430fb
docs: Rewritten Quickstart, Getting Started and Contributing, and als…
SaptarshiSarkar12 Jul 23, 2024
94fbe75
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 Jul 23, 2024
1f45e23
fix(CI): Fixed linter issues
SaptarshiSarkar12 Jul 23, 2024
9b49e79
fix(CI): Fixed linter issues
SaptarshiSarkar12 Jul 23, 2024
a00c390
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 Jul 23, 2024
51c7951
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 Jul 27, 2024
3849aeb
feat(docs): Organized development flow and added more details in the …
SaptarshiSarkar12 Jul 29, 2024
94cc49b
fix(CI): Fixed linter issue
SaptarshiSarkar12 Jul 29, 2024
03a3be4
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 Jul 30, 2024
8ebeb4b
feat(docs): Added steps to generate graalvm metadata for both Drifty …
SaptarshiSarkar12 Jul 30, 2024
9a7fabf
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 Jul 30, 2024
57b84a4
fix(CI): Fixed all typos and sentence improvements provided by CodeRa…
SaptarshiSarkar12 Jul 30, 2024
87331c6
docs: Added Usage guidelines for both Drifty CLI and Drifty GUI
SaptarshiSarkar12 Aug 11, 2024
2455ffa
Merge branch 'master' of github.com:SaptarshiSarkar12/Drifty into has…
SaptarshiSarkar12 Aug 11, 2024
7eef297
docs: Added images for Usage guidelines of Drifty CLI
SaptarshiSarkar12 Aug 11, 2024
0b3dd80
docs: Fixed Coderabbit AI reviews
SaptarshiSarkar12 Aug 11, 2024
b43e6c1
docs: Fixed a grammatical error provided by Coderabbit AI
SaptarshiSarkar12 Aug 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions Website/app/docs/Faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Frequently Asked Questions related to Drifty

1. **Why does Drifty GUI not open in my Windows machine?**

➡️ Your Windows machine needs to have Microsoft Visual C++ Redistributable installed on your machine. You can download and install it from its [official download page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)

2. **Which IDE (Integrated Development Enviroment) should I use to open Drifty App Code in my Local enviroment?**

➡️ You can use any IDE you like but as Drifty is based on Java, it is recommended to use [IntelliJ IDEA](https://www.jetbrains.com/idea/). You can use the free Community version of IntelliJ Idea if you do not have a JetBrains subscription.

3. **How can I get updates related to this project?**

➡️ You can join our [Discord server](https://discord.com/invite/DeT4jXPfkG) to get updates on this project. You can also watch this repository by clicking on teh watch 👁️ button [here](https://github.com/SaptarshiSarkar12/Drifty) and select notification types to **All Acticity** to get all updates on this project
hasnainmakada-99 marked this conversation as resolved.
Show resolved Hide resolved

4. **What technologies does Drifty use?**

➡️ The technologies that Drifty uses are 👇
- Java - for Drifty Application (both CLI and GUI)
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
- JavaFX - for Drifty's GUI part only
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
- Docker - for containerizing the Applcation to provide multiple accesss to beta features
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
- NextJS - for building the official [Drifty's Website](https://saptarshisarkar12.github.io/Drifty/)
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved

5. **How can I contribute to Drifty?**

➡️ You can check the [Contribution](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CONTRIBUTING.md) section of this docs to learn how to contribute to this project.

6. **How can I update Drifty to the lates version?**
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved

➡️ Currently, automatic updates are not supported and is a [Work-In-Progress](https://github.com/SaptarshiSarkar12/Drifty/issues/217). So in order to update it, you need to download [the latest executable](https://saptarshisarkar12.github.io/Drifty/download) from the official website and install it accordingly.
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved

7. **How can I access the Beta features in Drifty?**

➡️ Currently, Beta features are available only through Docker images. You can check the official [GitHub Docs for Drifty](https://github.com/SaptarshiSarkar12/Drifty/blob/master/README.md).
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved

8. **In-detail explanations of Drifty needed?**
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
➡️ For more queries related to the further improvment of any aspect of this project, you can raise a issue [here](https://github.com/SaptarshiSarkar12/Drifty/issues) or reach out to the maintainers on the [discord server](https://discord.com/invite/DeT4jXPfkG), we're happy to help you 😄
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved

63 changes: 63 additions & 0 deletions Website/app/docs/Getting-Started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Installing Drifty GUI

## On Windows 🪟

- Go to the official website of Drifty and then click on the download button, it will redirect you to the downloads page 📃

![Download Design](https://github.com/hasnainmakada-99/Drifty/assets/82728823/43800a72-f262-4b29-a156-6057e1652caf)

- After getting redirected to the downloads page select the application type whether you want to download the GUI or CLI version of it, by default it is set to GUI

![Application Type](https://github.com/hasnainmakada-99/Drifty/assets/82728823/4e20de64-7657-4713-8795-447fa274d940)

SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
- Click on the windows button and it will ask you for the destination where you want to keep your file and it will start downloading the .exe 😄

![Windows Download Exp](https://github.com/hasnainmakada-99/Drifty/assets/82728823/cdd55640-978b-4caa-81e5-69e2c9b37743)


## On Linux 🐧

- Repeat the same steps as mentioned above in the windows process and click on the Linux button and it will start downloading for the same :smile:

![Linux Download Exp](https://github.com/hasnainmakada-99/Drifty/assets/82728823/38c5da57-7276-4772-b669-e7aac129a68d)

## On Mac 🍎

- Repeat the same steps as mentioned above in the windows process and click on the apple button and it will start downloading for the same :smile:

![MAC Download Exp](https://github.com/hasnainmakada-99/Drifty/assets/82728823/e03d6f54-119a-4458-9043-11e501fa69bd)

# Installing Drifty CLI

## On Windows

- After getting redirected to the downloads page select the application type whether you want to download the GUI or CLI version of it, This time we are going to select CLI

![Application Type](https://github.com/hasnainmakada-99/Drifty/assets/82728823/c689fe27-b00e-4099-babf-1d9fba663aec)



- Then select the windows button for it and it will download an executable which will directly get executed on your terminal 😄

![Drifty CLI Win Exp](https://github.com/hasnainmakada-99/Drifty/assets/82728823/0509f7bd-e398-4839-ac07-ca6afc6eba6a)

![Drifty CLI](https://github.com/hasnainmakada-99/Drifty/assets/82728823/dc544607-7ac2-476f-8162-af11a265fe57)



## On Linux

- The process is pretty much similar to what we saw in the windows part, for Linux it will also open inside the terminal, just download the Linux file as well from the downloads page 😄

![Linux exp CLI](https://github.com/hasnainmakada-99/Drifty/assets/82728823/9b2766cf-b14c-4767-9ad8-db880726a4c9)


## On Mac

- The process is pretty much similar to what we saw in the windows part, Mac it will also open inside the terminal, just download the Mac file as well from the downloads page 😄

![Mac exp CLI](https://github.com/hasnainmakada-99/Drifty/assets/82728823/57101891-f68f-4c05-9b4d-4a50ff38c2c2)




18 changes: 18 additions & 0 deletions Website/app/docs/Quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# A general overview of Dirfty

Dirfty is an open source Interactive file downloader software built using Java and NextJS, Its backend is powered by Java and the front end consists of NextJS and TailwindCSS

With the help of Dirfty, you can download files and videos from various sources such as YouTube, Instagram etc.. You can also download files by providing the link address if it's downloading way too slowly inside your browser.
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved

## Main Features of Drifty
- Free and Open Source forever
- Faster downloading of files, just like IDM
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
- Youtube, Instagram, Twitter/X etc.. Platforms supported
hasnainmakada-99 marked this conversation as resolved.
Show resolved Hide resolved
- Both CLI (Command Line Interface) and GUI (Graphical User Interface) are available
- Parallel downloading support provided
hasnainmakada-99 marked this conversation as resolved.
Show resolved Hide resolved

# Let's get you running

## A simple demo on how to get started with the GUI of Drifty
SaptarshiSarkar12 marked this conversation as resolved.
Show resolved Hide resolved
https://github.com/hasnainmakada-99/Drifty/assets/82728823/980cafd3-6e3e-4b56-a890-b96ec47b7593