From c13cb2fef031808b137517d726cd1850c47e1acd Mon Sep 17 00:00:00 2001 From: Andrea Spacca Date: Tue, 26 Jun 2018 19:09:43 +0200 Subject: [PATCH] Improved README --- .bowerrc | 2 +- README.md | 35 ++++++++++++++++++++++++++++++++--- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/.bowerrc b/.bowerrc index a001bf8..6ad533f 100644 --- a/.bowerrc +++ b/.bowerrc @@ -1,3 +1,3 @@ { - "directory": "transfersh-web/bower_components" + "directory": "src/bower_components" } diff --git a/README.md b/README.md index 13076ff..c7ecb71 100644 --- a/README.md +++ b/README.md @@ -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.