quickshare/README.md
Hexxa ede6c239f0
chore(ci/cd): refine scripts and docs (#36)
* chore(ci/cd): refine scripts and docs

* text(server): fix incorrect server port
2021-01-30 22:03:59 +08:00

50 lines
1.8 KiB
Markdown

<h1 align="center">
Quickshare
</h1>
<p align="center">
Simple file sharing service built with Go/Golang, Typescript, Gin, React, Boltdb, etc.
</p>
<p align="center">
<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" />
</a>
<a href="https://gitter.im/quickshare/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link">
<img src="https://badges.gitter.im/Join%20Chat.svg" />
</a>
<p>
![Quickshare on desktop](./docs/imgs/desktop.jpeg)
![Quickshare on mobile](./docs/imgs/mobile.jpeg)
Choose Language: English | [简体中文](./docs/README_zh-cn.md)
## Main Features
- Sharing files among different devices (Adaptive UI)
- Be compatible with Linux, Mac and Windows
- Stopping and resuming uploading/downloading
- Do uploading and downloading in web browser
## Quick Start
**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
Coming soon.