Skip to content

Commit

Permalink
Doc: add requirments section
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Bezzubov <[email protected]>
  • Loading branch information
bzz committed Jan 15, 2018
1 parent 3d8cd06 commit 510687d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 510687d

Please sign in to comment.