Skip to content

bblfsh/web

Repository files navigation

Babelfish web Build Status

Web client for Babelfish server.

It's a user-friendly tool for testing and studying how Babelfish parses source code.

Screenshot_gif

Installation

Babelfish server (v2.9.1 or newer) is required. If you don't have it running please read the getting started guide. You will learn how to use and deploy a bblfsh server.

Recommended way (using Docker)

docker run --privileged -d -p 9432:9432 --name bblfsh bblfsh/bblfshd:latest-drivers
docker run -p 8080:8080 --link bblfsh bblfsh/web -bblfsh-addr bblfsh:9432

When the server starts, the web client will be available on http://localhost:8080

Please read the getting started guide on how to use and deploy the bblfshd server, how to install drivers, etc.

Standalone

If you don't want to run the web client using our Docker image you can download a binary from the releases page and run it instead:

./bblfsh-web -bblfsh-addr <bblfsh-server-addr>

You can also configure the server in debug mode passing --debug extra flag, and the logging level with the LOG_LEVEL environment value:

LOG_LEVEL={debug,info,warning error} ./bblfsh-web -bblfsh-addr <bblfsh-server-addr> --debug

If none are set, its default values will be logging level info, and server in ReleaseMode.

Development

See CONTRIBUTING.md. There is information about the application architecture and how to build from sources.

Contributing

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

License

GPLv3, see LICENSE.