Skip to content

Commit

Permalink
Doc: update development instructions
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 db3dc5a commit 2f21b28
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 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).

### Dependencies

- Golang 1.9
- Node 8.x
- Yarn 1.x

## 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.

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
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@ If you don't have it running, please read the [getting started](https://doc.bblf
### Recomended way (using Docker)

```sh
docker run -p 8080:80 bblfsh/dashboard -bblfsh-addr <bblfsh-server-addr>
docker run --privileged -d -p 9432:9432 --name bblfsh bblfsh/bblfshd
docker run -p 8080:80 --link bblfsh bblfsh/dashboard -bblfsh-addr bblfsh:9432
```

When server starts dashboard will be available on http://localhost:8080

Please read the [getting started](https://doc.bblf.sh/user/getting-started.html) guide, to learn more about how to use and deploy a bblfsh server, install drivers, etc.

### Standalone

If don't want to run **dashboard** using our *Docker* image you can download a binary from [releases](https://github.com/bblfsh/dashboard/releases) page and run it as
Expand All @@ -27,9 +30,14 @@ If don't want to run **dashboard** using our *Docker* image you can download a b
./bblfsh-dashboard -bblfsh-addr <bblfsh-server-addr>
```

## Development

See relevant sections on [CONTRIBUTING.md](CONTRIBUTING.md) for information on application [architecture](CONTRIBUTING.md#Architecture) and how [build it](CONTRIBUTING.md#Development) from sources.

## Contributing

Please take a look at [CONTRIBUTING](CONTRIBUTING.md) file to see how to contribute in this project, get more information about the dashboard [architecture](CONTRIBUTING.md#Architecture) and how to launch it for [development](CONTRIBUTING.md#Development) purposes.
Please take a look at [CONTRIBUTING](CONTRIBUTING.md) file to see how to contribute in this project.


## License

Expand Down

0 comments on commit 2f21b28

Please sign in to comment.