| commit | f0e8250c528a229d8890959f2e3d4745d7f1d66b | [log] [tgz] |
|---|---|---|
| author | Wm Leler <wmleler@google.com> | Wed Apr 08 15:47:11 2015 -0700 |
| committer | Wm Leler <wmleler@google.com> | Wed Apr 08 15:47:49 2015 -0700 |
| tree | 94bbaa1dcf686e2964c21d23ccaae162101d7576 | |
| parent | b8424a1a2db629ee98a5ae5856c0eb33e8331774 [diff] |
updates to README to match www page Change-Id: If89a6ba48f77b560351d14a0ab664f31efe7f5be
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, 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, invokinging methods to examine or modify the state of the service.
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 webapp 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
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, simply 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.
You can serve a local instance with the following command:
make start
This command compiles and launches the web app. Additionally, demo services that represent a virtual house and cottage are added to your local namespace.
Navigate to http://localhost:9001 to access 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
The namespace browser has some unit and integration tests that verify basic functionality.
Run these tests with the following command:
make test
The code repository for the Namespace Browser is on GitHub.
Bugs and other issues can be submitted to the Vanadium Issue Tracker.