From 640ff61422bc0ee3966941b93d9889ddbbd38d77 Mon Sep 17 00:00:00 2001 From: ckonstanski Date: Thu, 30 Jul 2026 18:17:14 -0600 Subject: more files --- src/dashboard/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 src/dashboard/README.md (limited to 'src/dashboard/README.md') diff --git a/src/dashboard/README.md b/src/dashboard/README.md new file mode 100644 index 0000000..1e2249e --- /dev/null +++ b/src/dashboard/README.md @@ -0,0 +1,25 @@ +# Dashboard Layout + +The dashboard has 2 main sections, the navigation sidebar and the main panel. + +The main panel uses a card layout to display different views into the data. + +![Dashboard Layout](documentation/images/dashboard_layout.jpg) + +## Adding a card +* Create a new card in the ```/templates/cards``` folder. +* Include the new card to the ```/templates/dashboard.html``` file. + +## Adding a new page +* Create a new page in the ```/templates``` folder. +* Follow the exact format as the dashboard.html file. +* Add new cards in the ```/templates/cards``` folder and include them in the new page. +* Update the sidebar file ```/templates/includes/sidebar.html``` with a link to the new page. + +## Register cronjobs for generating Dashboard reports +* Register - ```python3 manage.py crontab add``` +* List active cronjbos - ```python3 manage.py crontab show``` +* Remove all active cronjbos - ```python3 manage.py crontab remove``` +* Remove a single active cronjbos - ```python3 manage.py crontab remove ``` + +For more info see ![django-crontab](https://github.com/kraiz/django-crontab#readme) -- cgit v1.3