https://github.com/kumpelblase2/proxtop
An experimental proxer.me desktop client for doing the most common things.
https://github.com/kumpelblase2/proxtop
anime cross-platform electron javascript typescript
Last synced: 5 months ago
JSON representation
An experimental proxer.me desktop client for doing the most common things.
- Host: GitHub
- URL: https://github.com/kumpelblase2/proxtop
- Owner: kumpelblase2
- License: mit
- Created: 2015-09-25T17:24:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-14T00:00:51.000Z (over 3 years ago)
- Last Synced: 2024-04-14T22:23:42.013Z (about 2 years ago)
- Topics: anime, cross-platform, electron, javascript, typescript
- Language: TypeScript
- Homepage:
- Size: 7.85 MB
- Stars: 5
- Watchers: 5
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Proxtop - A proxer.me desktop client
Proxtop is an experimental attempt to create a desktop client for the popular german anime site [proxer.me](https://proxer.me).
This is considered experimental because there's no official API in place so this app parses the site itself to provide the content. Thus, the application might be less responsive as expected or even unusable. Another problem with this route is that UI changes _may_ break this application entirely.
 _(You can find more screenshots in the "screenshots" directory)_
## Goals
These goals are features/use cases that I want this app to provide to the user. All of them should be implemented until I consider this experiment 'done'.
- [x] Use your existing proxer.me account
- [x] View watchlist
- [x] Watch proxer HD streams
- [x] Update watchlist
- [x] Watch streams with favorite video player (prefered: MPV)
- [x] Get notifications on new watchlist releases
- [x] Read & Write messages
- [ ] Have a somewhat nice looking UI
## Optional Goals
Goals that I would like to implement afterwards, if I have interest in continuing. These might never be included.
- Browse animes and search
- Add same functionalities for mangas
- Forum notifications
## Technologies
- Electron
- Angularjs
## What this application is and is not
- It is _not_ a complete frontend/replacement for proxer.me, it is just an alternative frontend for doing the most common tasks on the site, such as watching anime.
- It is so far _not_ officially supported and thus just a community/personal effort.
## Packaged releases
You can find the latest packaged/stable releases under [Releases](https://github.com/kumpelblase2/proxtop/releases/latest) in the repository. There you can download the right archive for your platform. Extract it and run the `Proxtop` executable inside the directory. I currently provide packaged releases for Windows (32bit + 64bit), OSX and Debian, while also providing a general Linux archive. Arch Linux users can find the PKGBUILD files at [my pkbuild repo](https://github.com/kumpelblase2/pkgbuilds) for both stable and latest versions.
## How to run
To run this application from source you first need an API key from proxer. See
[the thread](https://proxer.me/forum/18-ankuendigungen-und-projekte/378833-die-wiedergeburt-der-proxer-api) for details.
First get all required dependencies (requires NPM to be installed):
```
npm ci
```
Run tests via:
```
npm test
```
Run the application via:
```
PROXER_API_KEY=your_proxer_api_key npm run start
# Or
PROXER_API_KEY=your_proxer_api_key ./run.sh
```
Or if you want to build the application:
```
npm run clean
PROXER_API_KEY=your_proxer_api_key npm run dist
# And if you want to package it:
PROXER_API_KEY=your_proxer_api_key npm run build:windows
```
## Debugging/Development
Proxtop is running inside Electron using TypeScript/JavaScript and is split in two halves: the "backend" and the "frontend". The backend is doing
all the heavy lifting, e.g. doing API requests, caching data and checking for new releases. On the other hand, the frontend is mostly for
displaying the information it receives from the backend and taking in user interaction, it shouldn't do many logic on its own.
These two communicate using the IPC provided by electron which is essentially events with a JSON payload.
The source is split accordingly, under `src/main` is the backend and under `src/renderer` is the frontend code.
As with this split, the application also needs to be debugged separately. The frontend can be debugged by pressing `Ctrl+Shift+I` while the app is
running to bring up Chrome Dev Tools which allows for client side debugging. While this is straight forward, it has one downside: Making a change
in the code requires you yo restart the application. Since this is not ideal, you can instead start the application in the following way. This
requires two consoles/shells as it requires two commands to be running concurrently.
In the first shell, run the following:
```
npm run webpack
```
Then in the second shell, you need to run this:
```
npm run debug
```
The first command starts webpack and tell it to watch for changes. Any time you now change a file, you can just reload the app (`Ctrl+R`) to reload
the changes. Sadly, the backend doesn't support that, so for backend changes an app restart is still necessary.
Additionally to webpack watching for files, the second command instructs electron to open a debug port at `5858` which can be used by your
IDE/editor to attach and debug the backend process. Once you're attached you can set breakpoints and debug along.
## FAQ
> This seems like a hard and terrible way to do it!
You might say that and you wouldn't be wrong. However, until the API is out, which might take forever, I still want something like this app to exist and that I can use. Even if it will end up in a state where only myself could use it, as long as it is there. Also, I've done some small parts this way in the past and those still work, so I don't really have a problem doing it this way.
> Why do you need an app on desktop if you have the browser?
This is a reasonable question, so let me tell you this:
1. In the browser the page is fixed, meaning the layout, menu and style are not really modifiable by me. If I don't like the style or if I want to make certain workflows faster, how would I do that? I don't want to end up with millions of lines of injected js code to change the site and get totally thrown off once the design changes. I'll probably end up with the same thing here, but in a separate app it's far easier to manage than a hacky script that ends up getting injected.
2. I cannot easily embed the content of the web page into other things, like a video player. There's no nice way for example to open the video in my local media player. Why would I want this? Better video controls, less memory footprint (some of the player are just ... ugh, shitty. Do you remember flash?) and brings more flexibility.
3. I can easily add new functionality without, again, fiddling with content scripts or maybe even doing things totally different.
TL;DR: Convenience, because I like to do things differently.
> Doesn't this hurt the page creators?!
Page load: Page load is a concern, as this is a hobby website and thus only limited resources are available. However, this is not really a concern as this app does similar/identical requests to the page as if a user would do the same steps. However, with convenience features like watchlist notification, this might be less true, as it has to check in the background if new ones are available which would cause more page loads to happen. I do believe however this is no big concern as by default these requests do not happen often.
Advertisements: There are three cases
1. You donate to the creators already, which results in no ads on the site, thus no difference.
2. You have an adblocker installed so you there's no difference either.
3. You have no adblocker installed and would normally see ads. This is the only case ad revenue would be missed.
I hate ads myself, so I don't see this app getting ads to increase revenue for the creators being a thing. Just donate; makes everyone happier.
## License
This application is licensed under the MIT license. See the `LICENSE` file in this repository for more information.
The Proxtop Logo is licensed under the Creative Commons BY-NC-SA 4.0. You can find more details and the full license text at http://creativecommons.org/licenses/by-nc-sa/4.0/ .