From 1220892237f5aa4b0e320ffedeb80ab8fd571f4a Mon Sep 17 00:00:00 2001 From: igoradamenko Date: Mon, 26 Mar 2018 16:06:24 +0300 Subject: [PATCH] add info about building frontend part to readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07630f2c..080ac5d7 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,24 @@ _instructions for google oauth2 setup borrowed from [oauth2_proxy](https://githu ### Frontend -TBD +Frontend part is building automatically along with backend if you use `docker-compose`. + +For manual installation: + +- Install [Node.js 8](https://nodejs.org/en/) or higher; +- Run `npm install` inside `./web`; +- Run `npm run build`; +- Result files will be saved in `./web/public`. + +For development mode use `npm start` instead of `npm run build`. +In this case `webpack` will serve files using `webpack-dev-server` on `localhost:8080`. + +Urls for development mode: + +- `localhost:8080` — page with embedded script from `REMARK_URL` (default: `https://demo.remark42.com`); +- `localhost:8080/dev.html` — page with embedded script from local folder; +- `localhost:8080/last-comments.html` — page with embedded script for last comments; +- `localhost:8080/counter.html` — page with embedded script for counter with examples. ## API