vinodpanicker / vega-editor

Web-based Vega and Vega-Lite authoring environment.

Vega Editor

The Vega editor is a web application for authoring and testing Vega visualizations. It includes a number of example specifications that showcase both the visual encodings and interaction techniques supported by Vega.

Usage Instructions

To run the editor locally, you must first install the dependencies and then launch a local web server. We assume you have npm installed.

1. Run npm run vendor to install 3rd party vendor libraries. This command will first run npm install to download the dependencies, and then copy the needed files into the vendor folder.

2. Launch a local web server to run the editor. For example, if you have Python installed on your system, run python -m SimpleHTTPServer 8000 in the top-level directory of this project and then point your browser to http://localhost:8000/.

Local Testing & Debugging

The editor is useful for testing if you are involved in Vega and Vega-Lite development. To use Vega, Vega-Lite, Vega Datasets, or Vega-Embed from another directory on your computer, link it into vendor. For this, run npm link in the directory of the library that you want to link. Then link a library into vendor with npm run vendor -- -l LIBRARY. This script also automatically links the node modules to your local library directory (if you previously ran npm link in that directory).

For example, to link Vega and Vega-Lite, run

cd VEGA_DIR
npm link

cd VEGA_LITE_DIR
npm link

cd VEGA_EDITOR_DIR
npm run vendor -- -l vega-lite -l vega