| Tyler Scott | 0826385 | 2015-07-31 19:05:52 -0600 | [diff] [blame] | 1 | NDN Catalog (NDN Query and Retrieval Tool) |
| 2 | ========================================== |
| 3 | |
| 4 | This is the front end to the catalog which contains all of the client html and code. |
| 5 | |
| 6 | Setup |
| 7 | ----- |
| 8 | |
| 9 | To simply run the client code, you will need the following things setup: |
| 10 | |
| 11 | * A NDN backend running somewhere (The default config is pointed at a test backend) |
| 12 | * NDN-JS |
| 13 | + Run `git submodule init ndn-js` in the client directory. |
| 14 | + Then run `git submodule update` |
| 15 | * Configure the config.json |
| 16 | + If it doesn't exist, you will need to copy it from the config-example.json |
| 17 | + config.json is intentionally left out of the git to prevent overwriting it. |
| 18 | |
| Tyler Scott | 9eb6abd | 2015-08-04 14:48:23 -0600 | [diff] [blame^] | 19 | config.json |
| 20 | ----------- |
| 21 | |
| 22 | catalogPrefix - This is where you are doing your catalog queries. This should be the root of where we are querying in ndn. |
| 23 | |
| 24 | 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. |
| 25 | |
| 26 | |
| 27 | Changing the theme |
| 28 | ------------------ |
| 29 | |
| 30 | Currently the theme is a modified bootstrap theme that is running larger fonts and custom colors. |
| 31 | |
| 32 | If you would like to modify the theme go to [this url](http://bootstrap-live-customizer.com/). 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). |
| 33 | |
| 34 | |
| 35 | |