Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ihexxa/quickshare
Quick and simple file sharing between different devices, built with Go, React and Typescript.
https://github.com/ihexxa/quickshare
file-sharing gin go golang javascript jest react reactjs sqlite typescript webpack yarn
Last synced: 1 day ago
JSON representation
Quick and simple file sharing between different devices, built with Go, React and Typescript.
- Host: GitHub
- URL: https://github.com/ihexxa/quickshare
- Owner: ihexxa
- License: lgpl-3.0
- Created: 2018-05-20T05:39:14.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T23:55:38.000Z (10 days ago)
- Last Synced: 2024-12-13T15:16:35.921Z (9 days ago)
- Topics: file-sharing, gin, go, golang, javascript, jest, react, reactjs, sqlite, typescript, webpack, yarn
- Language: Go
- Homepage: https://ihexxa.github.io/quickshare.site
- Size: 35.1 MB
- Stars: 515
- Watchers: 10
- Forks: 33
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quickshare
Quick and simple file sharing between different devices.
(Screenshots)
English | [简体中文](./docs/README_zh-cn.md)
> Quickshare is still under active development, please keep in mind that full backward compatibility is not guaranteed.
## Features
- File Management
- Support uploading, downloading, creating, deleting and moving files and folders
- Resumable uploading and downloading
- Manage files and folders in browser
- Search files and folders with multiple keywords in seconds
- Share directories to others, including anonymous
- Scan QR codes to visit sharing folders
- Upload hundreds of files at once
- Steaming uploading: make it work behind CDN or reverse proxy
- Files can also be managed from OS
- User Management
- Support multiple users
- Each user has a role (user/admin)
- User home directory
- Per-user download & upload speed limiting
- Per-user space quota
- MISC
- Adaptive UI
- I18n support
- Wallpaper customization
- Cross-platform: support Linux, Mac and Windows
## Quick Start
### Run in Docker (Recommended)
Following will start a `quickshare` docker and listen to `8686` port.
Then you can open `http://127.0.0.1:8686` and log in with user name `qs` and password `1234`:
```
docker run \
--name quickshare \
-d -p 8686:8686 \
-v `pwd`/quickshare/root:/quickshare/root \
-e DEFAULTADMIN=qs \
-e DEFAULTADMINPWD=1234 \
hexxa/quickshare
```
- `DEFAULTADMIN` is the default user name
- `DEFAULTADMINPWD` is the default user password
- `/quickshare/root` is where the Quickshare stores files and directories.
- Please refer to [this doc](./docs/doc.md) if you want to manage files and folders from OS.
### Run from source code
Before start, please confirm that Go/Golang (>=1.17), Node.js and Yarn are installed on your machine.
```
# clone this repo
git clone [email protected]:ihexxa/quickshare.git
# go to repo's folder
cd quickshare
DEFAULTADMIN=qs DEFAULTADMINPWD=1234 yarn start
```
OK! Open `http://127.0.0.1:8686` in browser, and log in with user name `qs` and password `1234`.
### Run executable file
- **Downloading**: Download last distribution(s) in [Release Page](https://github.com/ihexxa/quickshare/releases).
- **Unzipping**: Unzip it and run following command `DEFAULTADMIN=qs DEFAULTADMINPWD=1234 ./quickshare`. (You may update its execution permission: e.g. run `chmod u+x quickshare`)
- **Accessing**: At last, open `http://127.0.0.1:8686` in browser, and log in with user name `qs` and password `1234`.
### FAQ
Coming soon.