Skip to content

Commit

Permalink
Doc: update development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bzz authored Dec 12, 2017
1 parent b5a2e3d commit e3eb17a
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,18 @@ docker run -p 8080:80 bblfsh/dashboard -bblfsh-addr <bblfsh-server-addr>
If you don't have a bblfsh server running you can execute the dashboard and the server using the following command:

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

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

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.

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

0 comments on commit e3eb17a

Please sign in to comment.