doesnm/quickshare
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(ci/cd): refine scripts and docs (#36)

Browse source 
* chore(ci/cd): refine scripts and docs

* text(server): fix incorrect server port
This commit is contained in:
Hexxa 2021-01-30 22:03:59 +08:00 • committed by GitHub
parent e87a342c93
commit ede6c239f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 81 additions and 296 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -2,11 +2,11 @@
Quickshare
</h1>
<p align="center">
Simple file sharing server built with Go/Golang, Typescript, Gin, React, Boltdb, etc.
Simple file sharing service built with Go/Golang, Typescript, Gin, React, Boltdb, etc.
</p>
<p align="center">
<a href="https://travis-ci.org/ihexxa/quickshare">
<img src="https://travis-ci.org/ihexxa/quickshare.svg?branch=main" />
<a href="https://github.com/ihexxa/quickshare/actions">
<img src="https://github.com/ihexxa/quickshare/workflows/quickshare-ci/badge.svg" />
</a>
<a href="https://goreportcard.com/report/github.com/ihexxa/quickshare">
<img src="https://goreportcard.com/badge/github.com/ihexxa/quickshare" />
@ -16,29 +16,35 @@
</a>
<p>
![Quickshare demo](./demo.jpg)
![Quickshare on desktop](./docs/imgs/desktop.jpeg)
![Quickshare on mobile](./docs/imgs/mobile.jpeg)
Choose Language: English | [简体中文](./docs/README_zh-cn.md)
## Download
Visit [Release Page](https://github.com/ihexxa/quickshare/releases) to get Linux | Mac | Windows distribution(s).
## Main Features
- Uploading and downloading in browser without client
- Sharing files among different devices (Adaptive UI)
- Be compatible with Linux, Mac and Windows
- Sharing files among different devices (desktop & mobile)
- Stopping and resuming uploading/downloading
- Stopping and resuming uploading/downloading
- Do uploading and downloading in web browser
## Installation
## Quick Start
Coming soon.
**Downloading**: Download last distribution(s) in [Release Page](https://github.com/ihexxa/quickshare/releases).
**Unzipping**: Unzip it and run following command `./quickshare`. (You may update its execution permission: e.g. run `chmod u+x quickshare` on Linux)
**Starting**: At the first run, Quickshare will let you input your user name and generate a random password for you (here `quickshare` is the user name). It may output something like following (password is `2fdc98`):
```
Please input admin name: quickshare
password is generated: 2fdc98, please update it after login
user (quickshare) is created
```
**Accessing**: At last, open your browser and visit `http://127.0.0.1:8686`.
### FAQ
Please refer [FAQ document](./docs/FAQ_en-us.md)
### Contribution
TODO
Coming soon.