diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3de1721..262dac8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,15 +55,23 @@ The format can be described more formally as follows: ## Architecture -The dashboard contains 2 parts: +The Dashboard application consists of 2 parts: - Single page react application bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app) -- Go web server to proxy and transform requests to bblfsd server +- Go web server to proxy and transform requests to actual [bblfsh server](https://doc.bblf.sh/). For production usage, all static files are served from the go server after being embedded in the server itself using go [go-bindata](https://github.com/jteeuwen/go-bindata). ## Development +The dashboard is a Golang application, so in order for all further insturctions to work please make sure it's under `$GOPATH` in your filesystem. + +### Dependencies + + - Golang 1.9 + - Node 8.x + - Yarn 1.x + The dashboard uses an intermediate API that connects to the bblfsh server and serves the dashboard front assets. Every time you change any source of the front assets, it is needed to regenerate the `server/asset/asset.go` containing the static files of the site. diff --git a/README.md b/README.md index 527d71be..6cfa573c 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,7 @@ See relevant sections on [CONTRIBUTING.md](CONTRIBUTING.md) for information on a Please take a look at [CONTRIBUTING](CONTRIBUTING.md) file to see how to contribute in this project. + ## License GPLv3, see [LICENSE](LICENSE)