Skip to content

bblfsh/web

Repository files navigation

Dashboard GitHub version Build Status

Web dashboard for Babelfish server.

It's user-friendly tool for testing and research how babelfish parse code.

Screenshot

Installation

Babelfish server is required for dashboard. If you don't have it running, please read the getting started guide, to learn more about how to use and deploy a bblfsh server.

Fetching drivers from server

The dashboard automatically fetches the drivers from the bblfsh server. To do so, it calls to gRPC bblfshd/daemon/protocol, using the control network used by bblfsh —that must be accessible for the dashboard—.

Recomended way (using Docker)

docker run --privileged -d -p 9432:9432 -p 9433:9433 --name bblfsh bblfsh/bblfshd -ctl-network=tcp -ctl-address=0.0.0.0:9433
docker run -p 8080:80 --link bblfsh bblfsh/dashboard -bblfsh-addr bblfsh:9432 -bblfshctl-addr bblfsh:9433

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

Please read the getting started 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 page and run it as

./bblfsh-dashboard -bblfsh-addr <bblfsh-server-addr> -bblfshctl-addr <bblfsh-server-ctl-addr>

Development

See relevant sections on CONTRIBUTING.md for information on application architecture and how build it from sources.

Contributing

Please take a look at CONTRIBUTING file to see how to contribute in this project.

License

GPLv3, see LICENSE