An open API service indexing awesome lists of open source software.

https://github.com/bblfsh/web

Web client for Babelfish server
https://github.com/bblfsh/web

babelfish frontend tool ui web

Last synced: about 2 months ago
JSON representation

Web client for Babelfish server

Awesome Lists containing this project

README

          

# Babelfish web [![Build Status](https://travis-ci.org/bblfsh/web.svg?branch=master)](https://travis-ci.org/bblfsh/web)

Web client for [Babelfish server](https://bblf.sh).

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

![Screenshot_gif](images/web.gif?raw=true)

## Installation

Babelfish server (v2.9.1 or newer) is required.
If you don't have it running please read the [getting started](https://doc.bblf.sh/using-babelfish/getting-started.html) guide. You will learn how to use and deploy a bblfsh server.

### Recommended way (using Docker)

```sh
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](https://doc.bblf.sh/using-babelfish/getting-started.html) 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](https://github.com/bblfsh/web/releases) and run it instead:

```sh
./bblfsh-web -bblfsh-addr
```

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

```sh
LOG_LEVEL={debug,info,warning error} ./bblfsh-web -bblfsh-addr --debug
```

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

## Development

See [CONTRIBUTING.md](CONTRIBUTING.md). There is information about the [application architecture](CONTRIBUTING.md#Architecture) and how to [build](CONTRIBUTING.md#Development) from sources.

## Contributing

Please take a look at [CONTRIBUTING](CONTRIBUTING.md) file to see how to contribute in this project.

## License

GPLv3, see [LICENSE](LICENSE).