From 1403433573ed0702add86f842583e7fb962a9030 Mon Sep 17 00:00:00 2001 From: psi Date: Wed, 13 Jun 2018 04:01:08 +0900 Subject: [PATCH] README --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ package.json | 3 ++- 2 files changed, 46 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1c6c41c..bda3b63 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,56 @@ # How to build +## Prerequirements + +#### ServerSide + ```bash +# for logging go get -u "github.com/Sirupsen/logrus" +go get -u "github.com/fatih/color" + +# networking go get -u "golang.org/x/net/context" go get -u "github.com/julienschmidt/httprouter" + +# data serialization go get -u "gopkg.in/yaml.v2" + +# imaging +go get -u "github.com/rwcarlsen/goexif" go get -u "github.com/nfnt/resize" go get -u "github.com/oliamb/cutter" go get -u "github.com/disintegration/imaging" +go get -u "github.com/nfnt/resize" +``` + +### ClientSide + +```bash +npm install + +# to upgrade, + +npm run update # update package.json +npm update # update package-lock.json +``` + +## Iterative and incremental development + +```bash +npm run watch +open http://localhost:8080/ +``` + +## Build + +```bash +npm run build +``` + +## Deploy + +```bash +npm run deploy ``` diff --git a/package.json b/package.json index 875331c..523a531 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "scripts": { "build": "gulp build", "watch": "gulp watch", - "update": "npm-check-updates -u" + "deploy": "gulp deploy", + "update": "npm-check-updates -u -a" }, "repository": { "type": "git",