https://github.com/dvcol/synology-download

Synology Download Station browser extension built with React.
https://github.com/dvcol/synology-download

chrome-extension extension react typescript

Last synced: 2 days ago
JSON representation

Synology Download Station browser extension built with React.

• Host: GitHub
• URL: https://github.com/dvcol/synology-download
• Owner: dvcol
• License: mit
• Created: 2021-09-03T09:00:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-29T14:22:23.000Z (10 days ago)
• Last Synced: 2024-12-30T21:11:52.167Z (9 days ago)
• Topics: chrome-extension, extension, react, typescript
• Language: TypeScript
• Homepage: https://dvcol.github.io/synology-download/
• Size: 11.7 MB
• Stars: 62
• Watchers: 3
• Forks: 6
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Welcome to Synology Download 👋



  

  

  

    

  

  

    

  

  

    

  

 

    

  



> Synology Download is a React base Chrome extension to manage Synology Download Station tasks directly from the browser.

> The popup support the following functionalities

>

> * Tabbed download tasks display and filtering

> * Task pause, play, seed, delete, destination edit

> * Task creation through rich form (destination, url, ftp, zip password)

> * Http, Https, 2FA login over local network

> * Context menu creation (with custom destination)

> * Quick action menu creation (with custom destination)

> The content script supports the following functionalities:

>

> * One click download on magnet links

> * Quick menu dropdown if more than one exist

> * Rich task creation modal on quick action or context menu

> * In-page notification for task creation

> The service worker supports the following functionalities:

>

> * Periodic task polling

> * Custom badge number and text display for filtered tasks (by tabs, status, destination)

> * Browser notifications on task completion/error (conditional on polling behavior and extensions permissions)

## Limitation

> Quick-connect login is not currently supported due to the lack of official API documentation.

>

> Currently, only magnet urls are supported for the quick action menu.

>

> Note that translation on previous version of Chrome (100 and below) might have only partial support in banner notifications.

>

> Due to MV3 current limitation, the service-worker is maintained awake through periodic messaging on active tab, if no tab is active in the past 5 minutes, service worker and associated functionalities might suspend until wake events.

## Prerequisites

- npm >=7.10.0

- node >=16.0.0

## Install

```sh

npm install

```

## Usage

To start the dev server (hot reload popup and service worker, but not content script)

```sh

npm run start

```

To build for production

```sh

npm run build

```

See [package.json](https://github.com/dvcol/synology-download/blob/main/package.json) for other useful scripts.

## Run tests

```sh

npm run test:unit

```

## Author

* Github: [@dvcol](https://github.com/dvcol)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/dvcol/synology-download/issues).

## Show your support

Give a ⭐️ if this project helped you!

 

    

 

  

## Download

* [Github Releases](https://github.com/dvcol/synology-download/releases)

* [Download Station (client for Synology NAS)](https://chrome.google.com/webstore/detail/download-station-client-f/ebbdkledlkjpgbbmmopgbnnjmklnkcef)

 

    

 

## 📝 License

This project is [MIT](https://github.com/dvcol/synology-download/blob/master/LICENSE) licensed.

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_