Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Niweera committed May 16, 2022
1 parent a178002 commit c2dca1e
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 42 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
[![action status badge](https://github.com/Niweera/niwder/actions/workflows/firebase-hosting-merge.yml/badge.svg)](https://github.com/Niweera/niwder/actions)
[![action status badge](https://github.com/Niweera/niwder/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Niweera/niwder/actions)

# Niwder
```
__ __ __ __ __
| \ | \| \ | \ | \
| $$\ | $$ \$$ __ __ __ ____| $$ ______ ______ \$$ ______
| $$$\| $$| \| \ | \ | \ / $$ / \ / \ | \ / \
| $$$$\ $$| $$| $$ | $$ | $$| $$$$$$$| $$$$$$\| $$$$$$\| $$| $$$$$$\
| $$\$$ $$| $$| $$ | $$ | $$| $$ | $$| $$ $$| $$ \$$| $$| $$ | $$
| $$ \$$$$| $$| $$_/ $$_/ $$| $$__| $$| $$$$$$$$| $$ __ | $$| $$__/ $$
| $$ \$$$| $$ \$$ $$ $$ \$$ $$ \$$ \| $$| \ | $$ \$$ $$
\$$ \$$ \$$ \$$$$$\$$$$ \$$$$$$$ \$$$$$$$ \$$ \$$ \$$ \$$$$$$
```

![image](src/helpers/cover_3.png)

Niwder (a combo of words, [NIWeera](https://github.com/Niweera), DownloadER) is a long time dream of mine (actually I got this idea around 2017, thanks to [nisalb](https://github.com/nisalb)), and I tried to realize this dream for years but to no avail until now.
# Niwder

Niwder (a combo of words, [NIWeera](https://github.com/Niweera), DownloadER) is a long time dream of mine (actually I
got this idea around 2017, thanks to [nisalb](https://github.com/nisalb)), and I tried to realize this dream for years
but to no avail until now.

Niwder is a system in three parts where,

Expand All @@ -15,17 +29,26 @@ Niwder is a system in three parts where,

![image](src/helpers/system.jpg)

Currently, a user can add a [Mega.nz](https://mega.nz) file link, and get it converted to a [Google Drive](https://drive.google.com) file link. Since handling a public faced Google Drive app authentication is a big hassle (you need to get the Drive app verified), I have used a dummy Google Drive account for storing the transferred Mega.nz file. In a future release, I will try to add a feature so that anyone can get their files straight into their Google Drive.
Currently, a user can add a [Mega.nz](https://mega.nz) file link, and get it converted to
a [Google Drive](https://drive.google.com) file link. Since handling a public faced Google Drive app authentication is a
big hassle (you need to get the Drive app verified), I have used a dummy Google Drive account for storing the
transferred Mega.nz file. In a future release, I will try to add a feature so that anyone can get their files straight
into their Google Drive.

When a user add a Mega.nz file, the [Niwder-API](https://github.com/Niweera/niwder-api) will queue the transfer job using [Niwder-Worker](https://github.com/Niweera/niwder-api/tree/main/src/worker) and the Niwder-Worker will handle the transfer job and transfer the Mega.nz file to a pre-determined Google Drive. The [Google Drive SDK](https://developers.google.com/drive) will provide the pre-shared download link for the transferred file, and it will be visible in the [Niwder-UI](https://github.com/Niweera/niwder).
When a user add a Mega.nz file, the [Niwder-API](https://github.com/Niweera/niwder-api) will queue the transfer job
using [Niwder-Worker](https://github.com/Niweera/niwder-api/tree/main/src/worker) and the Niwder-Worker will handle the
transfer job and transfer the Mega.nz file to a pre-determined Google Drive.
The [Google Drive SDK](https://developers.google.com/drive) will provide the pre-shared download link for the
transferred file, and it will be visible in the [Niwder-UI](https://github.com/Niweera/niwder).

Niwder-UI and Niwder-API use [Firebase](https://firebase.google.com/) for hosting and authentication.

![image](src/helpers/ui.jpg)

__🔥 Niwder.io uses [WebTorrent](https://github.com/webtorrent/webtorrent) for transferring torrents.__

__🍭 Niwder.io uses [FingerPrintJS](https://fingerprintjs.com) for anonymizing the user agents for storing Firebase Cloud Messaging keys.__
__🍭 Niwder.io uses [FingerPrintJS](https://fingerprintjs.com) for anonymizing the user agents for storing Firebase
Cloud Messaging keys.__

![image](src/helpers/torrents-download-demo.gif)

Expand Down
33 changes: 19 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
"@testing-library/user-event": "^13.5.0",
"axios": "^0.26.1",
"buffer": "^6.0.3",
"figlet": "^1.5.2",
"firebase": "^9.8.1",
"https-browserify": "^1.0.0",
"javascript-time-ago": "^2.3.13",
Expand Down
52 changes: 30 additions & 22 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,8 @@ import store, { rrfProps } from "./store";
import { ReactReduxFirebaseProvider } from "react-redux-firebase";
import TimeAgo from "javascript-time-ago";
import en from "javascript-time-ago/locale/en.json";
import figlet from "figlet";
import one from "figlet/importable-fonts/Big Money-se";
import two from "figlet/importable-fonts/Bigfig";
import three from "figlet/importable-fonts/Sweet";

TimeAgo.addDefaultLocale(en);
figlet.parseFont("One", one);
figlet.parseFont("Two", two);
figlet.parseFont("Three", three);

ReactDOM.render(
<React.StrictMode>
Expand All @@ -39,18 +32,35 @@ if ("serviceWorker" in navigator) {
});
}

console.log(
figlet.textSync("Niwder.io", {
font: "One",
}),
figlet.textSync("Want to contribute?", {
font: "Two",
}),
"\n\n",
figlet.textSync("Fork", {
font: "Three",
}),
`\n .
console.log(` __ __ __ __ __
| \\ | \\| \\ | \\ | \\
| $$\\ | $$ \\$$ __ __ __ ____| $$ ______ ______ \\$$ ______
| $$$\\| $$| \\| \\ | \\ | \\ / $$ / \\ / \\ | \\ / \\
| $$$$\\ $$| $$| $$ | $$ | $$| $$$$$$$| $$$$$$\\| $$$$$$\\| $$| $$$$$$\\
| $$\\$$ $$| $$| $$ | $$ | $$| $$ | $$| $$ $$| $$ \\$$| $$| $$ | $$
| $$ \\$$$$| $$| $$_/ $$_/ $$| $$__| $$| $$$$$$$$| $$ __ | $$| $$__/ $$
| $$ \\$$$| $$ \\$$ $$ $$ \\$$ $$ \\$$ \\| $$| \\ | $$ \\$$ $$
\\$$ \\$$ \\$$ \\$$$$$\\$$$$ \\$$$$$$$ \\$$$$$$$ \\$$ \\$$ \\$$ \\$$$$$$
| | _ __ _|_ _|_ _ _ _ __ _|_ __ o |_ _|_ _ )
|^|(_|| | |_ |_(_) (_ (_)| | |_ | | |_)|_| |_(/_ o
.-. ___
/ \\ ( )
| .\`. ; .--. ___ .-. | | ___
| |(___) / \\ ( ) \\ | | ( )
| |_ | .-. ; | ' .-. ; | | ' /
( __) | | | | | / (___) | |,' /
| | | | | | | | | . '.
| | | | | | | | | | \`. \\
| | | ' | | | | | | \\ \\
| | ' \`-' / | | | | \\ .
(___) \`.__.' (___) (___ ) (___)
.
.
. ;.
.;
Expand All @@ -64,9 +74,7 @@ console.log(
;;;;;
..;;;;;..
':::::'
':\`
`
);
':\``);

console.log(
"%c https://github.com/Niweera/niwder.git",
Expand Down

0 comments on commit c2dca1e

Please sign in to comment.