'README.md' updaten

This commit is contained in:
2020-07-18 00:28:02 +00:00
parent 7c6c0dc20f
commit 75fc28f464

View File

@@ -3,8 +3,20 @@
This repository contains the web frontend for [transfer.sh](https://github.com/dutchcoders/transfer.sh/) modified by Brammp.
## How to use it
## Atatch to transfer.sh
### Pre-build
Download and extract the release to a folder
Docker Sample :
```
docker run -d -v /folder:/uploads -v /root/<extactionfolder>:/webapp --publish 5000:8080 dutchcoders/transfer.sh:latest --provider local --basedir /uploads --web-path /webapp/
```
Go Prebuild Sample :
```
./transfersh-v1.1.7-linux-amd64 --provider=local --listener :8080 --temp-path=/tmp/ --basedir=/tmp/ --web-path /root/<extactionfolder>
```
### Manual build
You must specify `web-path` directory, pointing to `dist` generated folder (Grunt & bindata)
Docker Sample :
@@ -15,32 +27,26 @@ Go Prebuild Sample :
```
./transfersh-v1.1.7-linux-amd64 --provider=local --listener :8080 --temp-path=/tmp/ --basedir=/tmp/ --web-path /brammp_transfer.sh-web/dist
```
## Requirement
You must install first :
## Manual building instructions
### Requirement
* Nodejs 10
* Grunt
* Bower
* Go & go-bindata (go get -u github.com/shuLhan/go-bindata/...)
## Initialization
### Initialization
NPM
```
npm install
```
Bower
*Please*, specify to Bower where to install its packets via .bowerrc, to the `src/bower_components` directory
```
bower install
```
## Build
### Build
```
$ grunt build
$ go generate .
```
## Verify
### Verify
You should see a `dist` directory, where all the basic .html are generated.