This repository has been archived on 2022-01-02. You can view files and clone it, but cannot push or open issues or pull requests.
AriaNg/README.md

70 lines
3.7 KiB
Markdown
Raw Normal View History

2016-05-13 17:57:42 +02:00
# AriaNg
2016-08-01 16:14:05 +02:00
[![License](https://img.shields.io/github/license/mayswind/AriaNg.svg?style=flat)](https://github.com/mayswind/AriaNg/blob/master/LICENSE)
2018-09-04 04:58:33 +02:00
[![Lastest Build](https://img.shields.io/circleci/project/github/mayswind/AriaNg.svg?style=flat)](https://circleci.com/gh/mayswind/AriaNg/tree/master)
2016-08-01 16:14:05 +02:00
[![Lastest Release](https://img.shields.io/github/release/mayswind/AriaNg.svg?style=flat)](https://github.com/mayswind/AriaNg/releases)
2016-07-06 19:00:59 +02:00
2016-07-06 16:44:39 +02:00
## Introduction
2017-08-01 16:36:46 +02:00
AriaNg is a modern web frontend making [aria2](https://github.com/aria2/aria2) easier to use. AriaNg is written in pure html & javascript, thus it does not need any compilers or runtime environment. You can just put AriaNg in your web server and open it in your browser. AriaNg uses responsive layout, and supports any desktop or mobile devices.
2016-06-04 09:55:18 +02:00
## Features
2016-07-06 16:44:39 +02:00
1. Pure Html & Javascript, no runtime required
2. Responsive design, supporting desktop and mobile devices
3. User-friendly interface
2018-11-17 09:09:25 +01:00
* Sort tasks (by name, size, progress, remaining time, download speed, etc.), files, bittorrent peers
2016-07-06 16:44:39 +02:00
* Search tasks
2018-11-17 09:09:25 +01:00
* Retry tasks
2018-08-15 11:01:44 +02:00
* Adjust task order by dragging
2016-07-10 16:12:35 +02:00
* More information of tasks (health percentage, client infomation of bt peers, etc.)
2018-11-17 09:09:25 +01:00
* Filter files by spectificed file types (videos, audios, pictures, documents, applications, archives, etc.) or file extensions
2018-08-15 11:01:44 +02:00
* Tree view for multi-directory task
* Download / upload speed chart for aria2 or single task
* Full support for aria2 settings
2017-03-20 17:04:15 +01:00
4. Url command line api support
2016-07-16 16:21:59 +02:00
5. Download finished notification
6. Multi-languages support
2017-03-19 17:00:20 +01:00
7. Multi aria2 RPC host support
2018-08-15 11:11:58 +02:00
8. Exporting and Importing settings support
2018-08-15 11:01:44 +02:00
9. Less bandwidth usage, only requesting incremental data
2016-06-05 08:02:36 +02:00
2016-07-03 13:20:26 +02:00
## Screenshots
2016-07-06 16:44:39 +02:00
#### Desktop
2017-03-20 01:52:48 +01:00
![AriaNg](https://raw.githubusercontent.com/mayswind/AriaNg-WebSite/master/screenshots/desktop.png)
2016-07-04 17:41:30 +02:00
#### Mobile Device
2017-03-20 01:52:48 +01:00
![AriaNg](https://raw.githubusercontent.com/mayswind/AriaNg-WebSite/master/screenshots/mobile.png)
2016-07-03 13:20:26 +02:00
2016-08-01 16:14:05 +02:00
## Installation
2018-11-18 06:07:55 +01:00
AriaNg now provides three versions, standard version, all-in-one version and [AriaNg Native](https://github.com/mayswind/AriaNg-Native). Standard version is suitable for deployment in the web server, and provides resource caching and on-demand loading. All-In-One version is suitable for local using, and you can download it and just open the only html file in browser. [AriaNg Native](https://github.com/mayswind/AriaNg-Native) is also suitable for local using, and is no need for browser.
2016-08-01 16:14:05 +02:00
#### Prebuilt release
2017-03-20 05:38:10 +01:00
Latest Release: [https://github.com/mayswind/AriaNg/releases](https://github.com/mayswind/AriaNg/releases)
2016-08-01 16:14:05 +02:00
2018-11-18 06:07:55 +01:00
Latest Daily Build (Standard Version): [https://github.com/mayswind/AriaNg-DailyBuild/archive/master.zip](https://github.com/mayswind/AriaNg-DailyBuild/archive/master.zip)
2016-08-08 16:26:33 +02:00
2016-08-01 16:14:05 +02:00
#### Building from source
2018-08-26 10:45:45 +02:00
Make sure you have [Node.js](https://nodejs.org/), [NPM](https://www.npmjs.com/) and [Gulp](https://gulpjs.com/) installed. Then download the source code, and follow these steps.
2016-07-06 16:44:39 +02:00
2018-11-18 06:07:55 +01:00
##### Standard Version
2016-07-03 15:12:48 +02:00
$ npm install
2016-07-04 17:41:30 +02:00
$ gulp clean build
2016-07-03 15:12:48 +02:00
2018-11-18 06:07:55 +01:00
##### All-In-One Version
$ npm install
$ gulp clean build-bundle
2016-07-03 15:12:48 +02:00
The builds will be placed in the dist directory.
2017-06-05 16:25:03 +02:00
#### Usage Notes
2018-11-18 06:07:55 +01:00
Since AriaNg standard version loads language resources asynchronously, you may not open index.html directly on the local file system to run AriaNg. It is recommended that you can use the all-in-one version or deploy AriaNg in a web container or download [AriaNg Native](https://github.com/mayswind/AriaNg-Native) that does not require a browser to run.
2017-06-05 16:25:03 +02:00
2017-03-26 07:41:47 +02:00
## Documents
1. [English](http://ariang.mayswind.net)
2. [Simplified Chinese (简体中文)](http://ariang.mayswind.net/zh_Hans)
2016-06-05 08:02:36 +02:00
## Demo
2017-03-20 05:38:10 +01:00
Please visit [http://ariang.mayswind.net/latest](http://ariang.mayswind.net/latest)
2016-07-03 13:20:26 +02:00
2016-07-06 16:44:39 +02:00
## License
[MIT](https://github.com/mayswind/AriaNg/blob/master/LICENSE)