browser: adding copyright headers and licensing files

Change-Id: I3910daf2f0c3f35501b7b27a0d32ed08758c289b
109 files changed
tree: f046c0e4617db2bc4ca67374739b0a123add2f01
  1. go/
  2. public/
  3. src/
  4. test/
  5. .gitignore
  6. .jshintrc
  7. AUTHORS
  8. bower.json
  9. CONTRIBUTORS
  10. css-transform.js
  11. LICENSE
  12. main-transform.js
  13. Makefile
  14. md-transform.js
  15. package.json
  16. PATENTS
  17. README.md
  18. VERSION
  19. web-component-dependencies.html
README.md

Viz Vanadium Viewer

Viz is a browser-like application that lets developers and other users view the Vanadium world. Starting from their namespace root, a user can see where services are mounted and browse through the mount table hierarchy. The user can also select a service to see more detailed information about it. A user can also interact with the service; by invoking methods they can examine or modify the service's state.

Installing the Vanadium Extension

Viz requires that users install the Vanadium Extension from the Chrome Web Store. Without this extension, Viz will not load properly.

Link to the Vanadium Extension: https://chrome.google.com/webstore/detail/vanadium-extension/jcaelnibllfoobpedofhlaobfcoknpap

##Building Viz

You will need to install the Vanadium environment and setup the web profile to build your own copy of Viz. See the development instructions for Vanadium for more information.

In order to build your own copy of Viz, simply run:

cd $VANADIUM_ROOT/release/projects/namespace_browser
make build

This compiles the relevant bundle files in the ‘public’ folder. The assets inside can be served as your own instance of Viz.

Running Viz locally for development

You can serve a local instance of Viz with the following command:

make start

Note: You will need to install the Vanadium environment and setup the web profile for this command to succeed.

This command compiles and launches Viz. Additionally, demo services that represent a virtual house and cottage are added to your local namespace.

Navigate to http://localhost:9000 to access Viz. You can quit by using CTRL-C on the console running make start

If you have any problems after updating the code, try cleaning the build.

make clean
make start

Testing Viz

Viz has some unit and integration tests that verify basic functionality.

Run these tests with the following command:

make test

There are no UI tests yet.

Contributing to Viz

Coming Soon! Meanwhile, you can submit issues and suggestions from Viz itself.

Deploy

If you do not have access to the vanadium-staging GCE account ping jasoncampbell@. Once you have access you will need to login to the account via the command line.

gcloud auth login

To deploy the site to https://staging.namespace.v.io use the make target deploy-staging.

make deploy-staging

This will sync the public directory to the private Google Storage bucket gs://staging.namespace.v.io which gets automatically updated to the nginx front-end servers. Currently all static content is protected by OAuth. For more details on the deployment infrastructure see this doc and the infrastructure repository.