Improved README

This commit is contained in:
Andrea Spacca 2018-06-26 19:09:43 +02:00
parent fca3a071d7
commit c13cb2fef0
2 changed files with 33 additions and 4 deletions

View File

@ -1,3 +1,3 @@
{
"directory": "transfersh-web/bower_components"
"directory": "src/bower_components"
}

View File

@ -2,11 +2,40 @@
This repository contains the web frontend for [transfer.sh](github.com/dutchcoders/transfer.sh/).
## Build
## How to use it
You must specify `web-path`directory, pointing to `dist` generated folder (Grunt & bindata)
Sample :
```
docker run -d -v /folder:/uploads -v /folder/dist:/webapp --publish 5000:8080 dutchcoders/transfer.sh:latest --provider local --basedir /uploads --web-path /webapp/
```
## Requirement
You must install first :
* Grunt
* Bower
* Go & go-bindata (go get -u github.com/shuLhan/go-bindata/...)
## 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
```
$ go get -u github.com/shuLhan/go-bindata/...
$ bower install
$ grunt build
$ go generate .
```
## Verify
You should see a `dist` directory, where all the basic .html are genereted.