diff --git a/README.md b/README.md index 3c1d93d..451534d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,53 @@ # satbd-explorer A small website to display http://satellite.bar 's BD thèque + +## Installation + +### Production + +For production use, we recommend to use the docker image. You do not want to mess with your server, do you ? + +In order to run, we need a csv file like one fetched from online.bdgest.com. + +```bash +docker build -t satbd . +mkdir -p /var/lib/satbd/log +cd /var/lib/satbd +docker run -d -p 33276:33276 --name satbd-runner --restart=on-failure:10 -v /var/lib/satbd/log:/satbd/tmp/log -v :/satbd/data.csv satbd ./satbd-explorer --csv data.csv +``` + +This will start the app on port 33276, and you can proxy pass your +frontend http(s) server to that port. + +As usual with docker, you can `ps`, `logs` , `stop` and `start` the +container. There is a large cache used by the app. In order to remove +it, simply `rm` and `run` it again. + +### Development + +The web applictaion is constitued of a backend golang server, and an angular frontend. + +#### Backend + +It requires go 1.5. Please follow instruction [here](golang.org) to get go. + +```bash +# ugly one line command to get all dependencies for package and tests +go get $(go list -e -f "{{.Imports}} {{.TestImports}}" | tr "[" " " | tr "]" " " | xargs go list -e -f "{{if not .Standard}}{{.ImportPath}}{{end}}") +make +``` + +#### Frontend + +Front end is build using npm and gulp. + +``` +# if you do not have gulp installed globaly yet +npm install -g gulp +npm install +gulp build +``` + + +