Skip to content

Commit

Permalink
Updated build
Browse files Browse the repository at this point in the history
  • Loading branch information
DGabri authored Jan 22, 2025
1 parent a4e86ca commit dfe85f3
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions doc/developers/README.GUI.utilization.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,8 @@
## GUI utilization guide

To create the dist of ntopng (compile vue code):
- cd httpdocs/dist/
- git checkout dev
- git pull
- cd ..
- make dist-ntopng
- cd httpdocs/dist/
- git add -u
- git commit -m "Update dist"
- git push
- cd ..
- git add httpdocs/dist
- git commit -m "Update dist ref"
- git push
- npm run build (to build css and js for the first time building)
- npm run build:js (to only build the js part)

- `/scripts/locales/en.lua` is a config file with key value pairs that are used in the GUI. Each key is used inside the GUI to display the relative value. Binding is done via utility function i18n:
1. `i18n(ENTRY)` which displays the value of ENTRY
Expand All @@ -24,4 +13,4 @@ To create the dist of ntopng (compile vue code):
1. `active` is used to highlight which page is currently selected
2. `page_name` refers to the name of the page
3. `url` (if present) represent the url to which you will be redirected if the icon or name is clicked. A utility function is present "ntop.getHttpPrefix()" which gets the url prefix for the ntopng instance, concatenate after the base url the params that are needed to be redirected to the target page
4. `label` is an html template icon. To display a tooltip on hover insert this in the html tag `data-bs-toggle=\"tooltip\" data-bs-placement=\"top\" title=\"" .. i18n(<ENTRY>) .. "\"`. <ENTRY> is a string to display content inside the tooltip. To retrieve ENTRY value please check `scripts/locales/en.lua` and search a relevant name to insert in the tooltip. If a relevant name is not present add an entry in the appropriate section inside en.lua
4. `label` is an html template icon. To display a tooltip on hover insert this in the html tag `data-bs-toggle=\"tooltip\" data-bs-placement=\"top\" title=\"" .. i18n(<ENTRY>) .. "\"`. <ENTRY> is a string to display content inside the tooltip. To retrieve ENTRY value please check `scripts/locales/en.lua` and search a relevant name to insert in the tooltip. If a relevant name is not present add an entry in the appropriate section inside en.lua

0 comments on commit dfe85f3

Please sign in to comment.