Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-atmos / 9eb6abd4bb4234471dca340c8414f8b349911fe7 / . / client / catalog
tree: a6aa8061692b6b288a10efd9c9624916554d3925 [path history] [tgz]
  1. .gitignore
  2. autocomplete.js
  3. catalog.js
  4. config-example.json
  5. index.html
  6. README.md
  7. sample.json
  8. search_catagories.json
  9. style.css
  10. theme.min.css
  11. variables.less
client/catalog/README.md

NDN Catalog (NDN Query and Retrieval Tool)

This is the front end to the catalog which contains all of the client html and code.

Setup

To simply run the client code, you will need the following things setup:

  • A NDN backend running somewhere (The default config is pointed at a test backend)
  • NDN-JS
    • Run git submodule init ndn-js in the client directory.
    • Then run git submodule update
  • Configure the config.json
    • If it doesn't exist, you will need to copy it from the config-example.json
    • config.json is intentionally left out of the git to prevent overwriting it.

config.json

catalogPrefix - This is where you are doing your catalog queries. This should be the root of where we are querying in ndn.

faceConfig - Configure where you have your backend running and on which port it is listening. To setup a new backend, please read the readme at the root of the repo.

Changing the theme

Currently the theme is a modified bootstrap theme that is running larger fonts and custom colors.

If you would like to modify the theme go to this url. To modify the current theme, then upload the variables.less in this folder, make your modifications, and overwrite the variables.less file when you are done (and the theme.min.css).