Google Git
Sign in
vanadium / release.projects.browser / 6e794ddbbd2ae62eb3812478d61e00407290baf7 / .
tree: 4fa3640625fc8fed64b2c040d938dcfa63909463 [path history] [tgz]
  1. go/
  2. public/
  3. src/
  4. test/
  5. .gitignore
  6. .jshintignore
  7. .jshintrc
  8. AUTHORS
  9. bower.json
  10. CONTRIBUTORS
  11. css-transform.js
  12. LICENSE
  13. main-transform.js
  14. Makefile
  15. md-transform.js
  16. package.json
  17. PATENTS
  18. README.md
  19. VERSION
  20. web-component-dependencies.html
README.md

Vanadium Namespace Browser

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

Installing the Vanadium Extension

As a Vanadium web application, the Namespace Browser requires that users install the Vanadium Extension from the Chrome Web Store. If you try to run the web app without the extension, it will prompt you to install it.

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

Hosted Namespace Browser

The Vanadium Namespace Browser lives online at https://browser.v.io/

Building the Namespace Browser

You do not need to build your own copy of the namespace browser in order to use it, unless you want to modify it or see how it works.

To build a local copy, install the Vanadium environment and be sure to include the web profile.

Here is the link to the development instructions for Vanadium: https://v.io/community/contributing.html

Next, to build your own copy of the namespace browser, run:

cd $V23_ROOT/release/projects/browser
make build

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

Running locally for development

You can serve a local instance of the Namespace Browser by executing the following command:

make start

Navigate to http://localhost:9001 to launch the namespace browser. 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

The namespace browser has some unit and integration tests that verify basic functionality. Run these tests with the following command:

make test

Contributing

The code repository for the Namespace Browser is on GitHub.

Bugs and other issues can be submitted to the Namespace Browser Issue Tracker.