7d361cdf7c
* chore(all): remove unused files * chore(ignore): ignore js builds * chore(js bundles): remove js builds and add env setup scripts * fix(build/template): fix incorrect prod template and add ignores * fix(browser): refine selected status style and small fixes * chore(readme): update readme status
73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
<h1 align="center">
|
|
[WORKING IN PROGRESS!!!] Quickshare
|
|
</h1>
|
|
<p align="center">
|
|
Simple file sharing server 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>
|
|
<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>
|
|
|
|
|
|
|
|
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).
|
|
|
|
## Features
|
|
|
|
- Upload and download in browser, no client
|
|
- Share files among desktop and mobile devices
|
|
- Portable software
|
|
- Add files from local
|
|
- Add download limit for resource
|
|
- Download from interrupted point
|
|
|
|
## Installation
|
|
|
|
2 steps are needed to start a quickshare: unzip it and start it.
|
|
|
|
The first step, unzip and start quickshare
|
|
|
|
### Linux
|
|
|
|
- Unzip the package: `unzip [package].` (`[package]` could be `quickshare_0.0.8_linux_x86_6 4.zip`)
|
|
- Start quickshare `./quickshare`
|
|
|
|
### Mac
|
|
|
|
- Unzip the package: `unzip [package].` (`[package]` could be `quickshare_0.0.8_macos_x86_64.zip`)
|
|
- Start quickshare `./quickshare`
|
|
|
|
### Windows
|
|
|
|
- Unzip the package
|
|
- Go into folder and click `quickshare.exe`
|
|
|
|
Last step, meet quickshare in browser
|
|
|
|
- Quickshare will start and show `quickshare starts @ [URL]` in terminal (e.g. `URL` could be `192.168.0.1:8888`)
|
|
- Open `URL` in browser and login with `admin` and `quicksh@re`
|
|
- Enjoy (But don't forget to change password according to [FAQ document](./docs/FAQ_en-us.md))
|
|
|
|
### FAQ
|
|
|
|
Please refer [FAQ document](./docs/FAQ_en-us.md)
|
|
|
|
### Configuration
|
|
|
|
Please refer [Configuration document](./docs/CONFIG_en-us.md)
|
|
|
|
### Contribution
|
|
|
|
Will add it soon...
|