Skip to content

Commit

Permalink
Removed Unnecessary Things
Browse files Browse the repository at this point in the history
  • Loading branch information
varbhat committed Jan 18, 2022
1 parent 94b88be commit 64be695
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 86 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,28 @@


## Introduction
exatorrent is [BitTorrent](https://www.bittorrent.org/) Client written in [Go](https://go.dev/).
It can be run locally or be hosted in Remote Server with good resources
to use that Server as [SeedBox](https://en.wikipedia.org/wiki/Seedbox).
It is Single Completely Statically Linked Binary with Zero External Dependencies .

exatorrent is simple yet feature-rich . It is
lightweight and light on resources. It comes with Beautiful Responsive Web Client written in Svelte and Typescript ,
but thanks to documented [WebSocket](https://datatracker.ietf.org/doc/html/rfc6455) [API](docs/API.md) of exatorrent , you can also write your own client if you want to.

exatorrent can operate in Optional Multi-User Mode administrated by admin user/s
but it can successfully be used by Single-User as well.
Torrented Files are stored in local disk of device where it's run, which are then retrievable or streamable via HTTP.
* exatorrent is Elegant [BitTorrent](https://www.bittorrent.org/) Client written in [Go](https://go.dev/).
* It is Simple, easy to use, yet feature rich.
* It can be run locally or be hosted in Remote Server with good resources.
* It is Single Completely Statically Linked Binary with Zero External Dependencies.
* It is lightweight and light on resources.
* It comes with Beautiful Responsive Web Client written in Svelte and Typescript.
* Thanks to documented [WebSocket](https://datatracker.ietf.org/doc/html/rfc6455) [API](docs/API.md) of exatorrent , custom client can be created.
* It supports Single User Mode and Multi User Mode.
* Torrented Files are stored in local disk can be downloaded and streamed via HTTP/Browser/Media Players.

<hr>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/main.png" alt="exatorrent web client" width=400 height=550 />
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/main.png" alt="exatorrent web client" width=400 height=550 />
<p align="center"><a href="docs/screenshots.md">More Screenshots →</a></p>
</p>
<hr>

## Installation
exatorrent can be installed in 3 ways.
* **Releases:** You can download binary for your OS from [Releases](https://github.com/varbhat/exatorrent/releases/latest) . Mark it as executable and run it . Refer [Usage](docs/usage.md) .
* **Releases:**

* exatorrent built executables are provided for Linux([amd64](https://github.com/varbhat/exatorrent/releases/latest/download/exatorrent-linux-amd64) and [arm64](https://github.com/varbhat/exatorrent/releases/latest/download/exatorrent-linux-arm64)), MacOS([Intel](https://github.com/varbhat/exatorrent/releases/latest/download/exatorrent-darwin-amd64) and [Apple Silicon](https://github.com/varbhat/exatorrent/releases/latest/download/exatorrent-darwin-arm64)) and Windows([amd64](https://github.com/varbhat/exatorrent/releases/latest/download/exatorrent-win-amd64.exe)).
* You can download binary for your OS from [Releases](https://github.com/varbhat/exatorrent/releases/latest) . Mark it as executable and run it . Refer [Usage](docs/usage.md) .
```bash
wget https://github.com/varbhat/exatorrent/releases/latest/download/exatorrent-linux-amd64
chmod u+x ./exatorrent-linux-amd64
Expand All @@ -44,11 +43,11 @@ exatorrent can be installed in 3 ways.
```bash
make web && make app
```
Note that **Username** and **Password** of Default User created on first run are `adminuser` and `adminpassword` respectively. You can change Password later but Username of Account can't be changed after creation. Refer [Usage](docs/usage.md#-admin) .

[Github Actions](https://github.com/features/actions) is used to build and publish [Releases](https://github.com/varbhat/exatorrent/releases/latest) and [Docker/Podman Images](https://ghcr.io/varbhat/exatorrent) of exatorrent .

If you want to deploy `exatorrent` on server , please also refer [Deploy Docs](docs/deploy.md) .
* Note that **Username** and **Password** of Default User created on first run are `adminuser` and `adminpassword` respectively.
* You can change Password later but Username of Account can't be changed after creation. Refer [Usage](docs/usage.md#-admin) .
* [Github Actions](https://github.com/features/actions) is used to build and publish [Releases](https://github.com/varbhat/exatorrent/releases/latest) and [Docker/Podman Images](https://ghcr.io/varbhat/exatorrent) of exatorrent .
* If you want to deploy `exatorrent` on server , please also refer [Deploy Docs](docs/deploy.md) .

## Features
* Single Executable File with No Dependencies
Expand Down Expand Up @@ -81,14 +80,13 @@ If you want to deploy `exatorrent` on server , please also refer [Deploy Docs](d
</p>

## Help

Communication about the project is primarily through [Discussions](https://github.com/varbhat/exatorrent/discussions) and the [Issues](https://github.com/varbhat/exatorrent/issues).
Communication about the project is primarily through the [Issues](https://github.com/varbhat/exatorrent/issues).

## Contribute
You are welcome to contribute . Please Read the [contributing docs](docs/CONTRIBUTING.md) first.
You are welcome to contribute. You can contribute code,documentation,icon or anything that you think benefits the project. If you want to implement any significant feature, please discuss it first.

## Thanks
Special Thanks to [anacrolix/torrent](https://github.com/anacrolix/torrent), Programming Languages and Libraries used in `exatorrent`, Awesome IDEs of [Jetbrains](https://jb.gg/OpenSource) for making this project happen.
Special Thanks to [anacrolix/torrent](https://github.com/anacrolix/torrent), Programming Languages and Libraries used in `exatorrent`, Awesome IDEs of [Jetbrains](https://jb.gg/OpenSource) and Users for making this project happen.

## License
[GPL-v3](LICENSE)
31 changes: 0 additions & 31 deletions docs/CONTRIBUTING.md

This file was deleted.

36 changes: 18 additions & 18 deletions docs/screenshots.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,54 @@
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/1.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/1.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/2.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/2.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/3.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/3.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/4.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/4.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/5.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/5.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/6.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/6.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/7.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/7.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/8.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/8.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/9.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/9.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/10.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/10.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/11.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/11.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/12.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/12.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/13.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/13.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/14.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/14.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/15.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/15.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/16.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/16.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/17.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/17.png" alt="exatorrent images"/>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/varbhat/assets/master/exatorrent/18.png" alt="exatorrent images"/>
<img src="https://raw.githubusercontent.com/varbhat/assets/main/exatorrent/18.png" alt="exatorrent images"/>
</p>
6 changes: 3 additions & 3 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ require (
github.com/pion/transport v0.13.0 // indirect
github.com/pion/turn/v2 v2.0.6 // indirect
github.com/pion/udp v0.1.1 // indirect
github.com/pion/webrtc/v3 v3.1.15 // indirect
github.com/pion/webrtc/v3 v3.1.16 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 // indirect
github.com/rs/dnscache v0.0.0-20211102005908-e0241e321417 // indirect
Expand All @@ -86,9 +86,9 @@ require (
golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
golang.org/x/text v0.3.7 // indirect
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
modernc.org/libc v1.13.2 // indirect
modernc.org/libc v1.14.3 // indirect
modernc.org/mathutil v1.4.1 // indirect
modernc.org/memory v1.0.5 // indirect
modernc.org/sqlite v1.14.4 // indirect
modernc.org/sqlite v1.14.5 // indirect
zombiezen.com/go/sqlite v0.8.0 // indirect
)
12 changes: 12 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -862,6 +862,8 @@ github.com/pion/webrtc/v3 v3.1.13 h1:2XxgGstOqt03ba8QD5+m9S8DCA3Ez53mULT4If8onOg
github.com/pion/webrtc/v3 v3.1.13/go.mod h1:RACpyE1EDYlzonfbdPvXkIGDaqD8+NsHqZJN0yEbRbA=
github.com/pion/webrtc/v3 v3.1.15 h1:JUNR95xdhcRliAaUQjnuttFPdxGxW/ixcwnHRjQFWOU=
github.com/pion/webrtc/v3 v3.1.15/go.mod h1:2brQHPJl93QVgbcVElY5syrrEzx5PXCxjrQ5g7Hwky8=
github.com/pion/webrtc/v3 v3.1.16 h1:/+0pX11In+9RStdXJAPw31A0UJjWbJtTBEGqj0YG+AA=
github.com/pion/webrtc/v3 v3.1.16/go.mod h1:2brQHPJl93QVgbcVElY5syrrEzx5PXCxjrQ5g7Hwky8=
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
Expand Down Expand Up @@ -1608,6 +1610,9 @@ modernc.org/ccgo/v3 v3.12.92/go.mod h1:5yDdN7ti9KWPi5bRVWPl8UNhpEAtCjuEE7ayQnzzq
modernc.org/ccgo/v3 v3.12.95/go.mod h1:ZcLyvtocXYi8uF+9Ebm3G8EF8HNY5hGomBqthDp4eC8=
modernc.org/ccgo/v3 v3.13.1/go.mod h1:aBYVOUfIlcSnrsRVU8VRS35y2DIfpgkmVkYZ0tpIXi4=
modernc.org/ccgo/v3 v3.14.0/go.mod h1:hBrkiBlUwvr5vV/ZH9YzXIp982jKE8Ek8tR1ytoAL6Q=
modernc.org/ccgo/v3 v3.15.1/go.mod h1:md59wBwDT2LznX/OTCPoVS6KIsdRgY8xqQwBV+hkTH0=
modernc.org/ccgo/v3 v3.15.9/go.mod h1:md59wBwDT2LznX/OTCPoVS6KIsdRgY8xqQwBV+hkTH0=
modernc.org/ccgo/v3 v3.15.10/go.mod h1:wQKxoFn0ynxMuCLfFD09c8XPUCc8obfchoVR9Cn0fI8=
modernc.org/ccorpus v1.11.1/go.mod h1:2gEUTrWqdpH2pXsmTM1ZkjeSrUWDpjMu2T6m29L/ErQ=
modernc.org/httpfs v1.0.6/go.mod h1:7dosgurJGp0sPaRanU53W4xZYKh14wfzX420oZADeHM=
modernc.org/libc v1.7.13-0.20210308123627-12f642a52bb8/go.mod h1:U1eq8YWr/Kc1RWCMFUWEdkTg8OTcfLw2kY8EDwl039w=
Expand Down Expand Up @@ -1659,6 +1664,10 @@ modernc.org/libc v1.12.0/go.mod h1:2MH3DaF/gCU8i/UBiVE1VFRos4o523M7zipmwH8SIgQ=
modernc.org/libc v1.13.1/go.mod h1:npFeGWjmZTjFeWALQLrvklVmAxv4m80jnG3+xI8FdJk=
modernc.org/libc v1.13.2 h1:GCFjY9bmwDZ/TJC4OZOUWaNgxIxwb104C/QZrqpcVEA=
modernc.org/libc v1.13.2/go.mod h1:npFeGWjmZTjFeWALQLrvklVmAxv4m80jnG3+xI8FdJk=
modernc.org/libc v1.14.1/go.mod h1:npFeGWjmZTjFeWALQLrvklVmAxv4m80jnG3+xI8FdJk=
modernc.org/libc v1.14.2/go.mod h1:MX1GBLnRLNdvmK9azU9LCxZ5lMyhrbEMK8rG3X/Fe34=
modernc.org/libc v1.14.3 h1:ruQJ8VDhnWkUR/otUG/Ksw+sWHUw9cPAq6mjDaY/Y7c=
modernc.org/libc v1.14.3/go.mod h1:GPIvQVOVPizzlqyRX3l756/3ppsAgg1QgPxjr5Q4agQ=
modernc.org/mathutil v1.1.1/go.mod h1:mZW8CKdRPY1v87qxC/wUdX5O1qDzXMP5TH3wjfpga6E=
modernc.org/mathutil v1.2.2/go.mod h1:mZW8CKdRPY1v87qxC/wUdX5O1qDzXMP5TH3wjfpga6E=
modernc.org/mathutil v1.4.0/go.mod h1:mZW8CKdRPY1v87qxC/wUdX5O1qDzXMP5TH3wjfpga6E=
Expand All @@ -1675,6 +1684,8 @@ modernc.org/sqlite v1.14.3 h1:psrTwgpEujgWEP3FNdsC9yNh5tSeA77U0GeWhHH4XmQ=
modernc.org/sqlite v1.14.3/go.mod h1:xMpicS1i2MJ4C8+Ap0vYBqTwYfpFvdnPE6brbFOtV2Y=
modernc.org/sqlite v1.14.4 h1:F3DRiVZKnCLqIQ0LhEGqBLnw9LcdADciCwCIHQ8bD5g=
modernc.org/sqlite v1.14.4/go.mod h1:LWtcO8JtBrt29KKmTqNNXDjAn36vHa/3nHvOYoVIAjc=
modernc.org/sqlite v1.14.5 h1:bYrrjwH9Y7QUGk1MbchZDhRfmpGuEAs/D45sVjNbfvs=
modernc.org/sqlite v1.14.5/go.mod h1:YyX5Rx0WbXokitdWl2GJIDy4BrPxBP0PwwhpXOHCDLE=
modernc.org/strutil v1.1.0/go.mod h1:lstksw84oURvj9y3tn8lGvRxyRC1S2+g5uuIzNfIOBs=
modernc.org/strutil v1.1.1/go.mod h1:DE+MQQ/hjKBZS2zNInV5hhcipt5rLPWkmpbGeW5mmdw=
modernc.org/tcl v1.5.0/go.mod h1:gb57hj4pO8fRrK54zveIfFXBaMHK3SKJNWcmRw1cRzc=
Expand All @@ -1689,6 +1700,7 @@ modernc.org/z v1.1.2/go.mod h1:sj9T1AGBG0dm6SCVzldPOHWrif6XBpooJtbttMn1+Js=
modernc.org/z v1.2.19/go.mod h1:+ZpP0pc4zz97eukOzW3xagV/lS82IpPN9NGG5pNF9vY=
modernc.org/z v1.2.20/go.mod h1:zU9FiF4PbHdOTUxw+IF8j7ArBMRPsHgq10uVPt6xTzo=
modernc.org/z v1.2.21/go.mod h1:uXrObx4pGqXWIMliC5MiKuwAyMrltzwpteOFUP1PWCc=
modernc.org/z v1.3.0/go.mod h1:+mvgLH814oDjtATDdT3rs84JnUIpkvAF5B8AVkNlE2g=
rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
Expand Down
2 changes: 1 addition & 1 deletion internal/core/version.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package core

const Version string = "v0.0.11"
const Version string = "v0.1.0"
18 changes: 9 additions & 9 deletions internal/web/package-lock.json

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

2 changes: 1 addition & 1 deletion internal/web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@tailwindcss/forms": "^0.4.0",
"postcss": "^8.4.5",
"tailwindcss": "^3.0.15",
"svelte-preprocess": "^4.10.1",
"svelte-preprocess": "^4.10.2",
"svelte": "latest"
}
}

0 comments on commit 64be695

Please sign in to comment.