2021-02-07 08:02:30 +01:00
|
|
|
|
|
|
|
|
# THome
|
|
|
|
|
THome is a static minimal personal dashboard made for local use, except its a bit easier to maintain and update it using python
|
|
|
|
|
|
|
|
|
|
I just wanted to make my own dashboard for my homelab and used the things i know to put it together as simple as i can
|
|
|
|
|
|
|
|
|
|
# Features
|
2021-02-07 08:35:15 +01:00
|
|
|
- simple design
|
|
|
|
|
- responsive, works great on PC, tablet and phone
|
|
|
|
|
- doesn't require any special dependencies, for linux at least
|
|
|
|
|
- has search to filter your cards
|
|
|
|
|
- works fast and perfectly without internet, since all the css and js are attached
|
2021-02-07 08:02:30 +01:00
|
|
|
|
2021-02-07 08:35:15 +01:00
|
|
|
# Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-02-07 08:02:30 +01:00
|
|
|
# requirement
|
2021-02-07 08:35:15 +01:00
|
|
|
- A Text Editor
|
|
|
|
|
- Python
|
|
|
|
|
- Web Browser
|
2021-02-07 08:02:30 +01:00
|
|
|
|
|
|
|
|
# How to use
|
2021-02-07 08:35:15 +01:00
|
|
|
- First of edit the sites.xml, change every thing in CAPS, add as many as you like
|
2021-02-07 08:02:30 +01:00
|
|
|
```
|
|
|
|
|
<item name = "NAME">
|
|
|
|
|
<tag>TAG</tag>
|
|
|
|
|
<tag_text>SHORT_TAG</tag_text>
|
|
|
|
|
<name>NAME</name>
|
|
|
|
|
<link>HTTPS://LINK.COM</link>
|
|
|
|
|
<image_name>FILENAME.PNG</image_name>
|
|
|
|
|
<powered_by>NAME</powered_by>
|
|
|
|
|
<description_en>TEXT</description_en>
|
|
|
|
|
<description_ar>نص</description_ar>
|
|
|
|
|
</item>
|
|
|
|
|
```
|
|
|
|
|
|
2021-02-07 11:20:02 +01:00
|
|
|
- for `<tag>` use the folowing categories or however you like (this affect the colors of the cards):
|
2021-02-07 08:38:47 +01:00
|
|
|
- "KB" Stands for: Knowledge Base and Wikis
|
|
|
|
|
- "SaM" Stands for: Social networks and media
|
|
|
|
|
- "WaB" Stands for: Websites and Blogs
|
|
|
|
|
- "SaI" Stands for: Search and Indexing
|
|
|
|
|
- "admin" Stands for: Admin tools and such
|
2021-02-07 08:02:30 +01:00
|
|
|
|
2021-02-07 08:35:15 +01:00
|
|
|
- Run the python script to create your index.html
|
2021-02-07 08:02:30 +01:00
|
|
|
`python main.py`
|
|
|
|
|
|
2021-02-07 08:35:15 +01:00
|
|
|
- put the files in your webserver or just open it in your web browser
|
2021-02-07 08:02:30 +01:00
|
|
|
|
|
|
|
|
# Used stuff
|
|
|
|
|
things used here:
|
2021-02-07 08:36:51 +01:00
|
|
|
- HTML
|
|
|
|
|
- CSS
|
|
|
|
|
- Bootstrap & jQuery
|
|
|
|
|
- [This script for the search](https://stackoverflow.com/a/61621522)
|
|
|
|
|
- Nord Colors
|
|
|
|
|
- Python
|
2021-02-07 11:22:01 +01:00
|
|
|
|
|
|
|
|
# TO DO
|
|
|
|
|
|
2021-02-07 11:24:39 +01:00
|
|
|
- [ ] well, I just realized not everyone needs a dual langage cards. so I will try to make it flexible to pick mono-lang or dual-lang
|
|
|
|
|
- [ ] make CLI for the python script, maybe
|
