The Vega editor is a web application for authoring and testing Vega and Vega-Lite visualizations. It includes a number of example specifications that showcase both the visual encodings and interaction techniques. It is deployed at https://vega.github.io/editor/.
To run the editor locally, you must first install the dependencies and then launch a local web server. We assume you have yarn installed.
- Install the dependencies:
$ yarn
- Start the server:
$ yarn start
- The local web server will be accessible from http://localhost:8080.
If you'd like to use Docker, there's a Docker Compose setup that you can use:
- Run the Docker Compose service:
$ docker-compose up
- The local web server will be accessible from http://localhost:8080. You can run yarn commands with
docker-compose run editor CMD
.
The editor is useful for testing if you are involved in Vega and Vega-Lite development. To use Vega, Vega-Lite, or Vega Datasets from another directory on your computer, you need to link it. For this, run yarn link
in the directory of the library that you want to link. Then, in this directory run yarn link <name of library>
, e.g. yarn link vega
.
For example, to link Vega, run
cd VEGA_DIR
yarn link
cd VEGA_EDITOR_DIR
yarn link vega
The Vega editor supports React Developer Tools and Redux DevTools.
We welcoime contirbutions and promptly review pull requests. For instructions about how to contribute, please follow the Vega-Lite contributing guidelines.
- Tag a new version with
yarn version
. Pre 1.x, update the minor version if there is a new feature. - Push the tag. Travis will automatically deploy the editor.