extern/THome
1
0
Fork 1
mirror of https://github.com/ve3lst/THome.git synced 2025-02-16 11:59:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Veelst 2021-02-07 10:35:15 +03:00 committed by GitHub
parent 042aff3d71
commit 2e73293de9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -5,19 +5,24 @@ THome is a static minimal personal dashboard made for local use, except its a bi
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
* 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
- 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
# Screenshots
![Laptop's screenshot 01!](media/screenshots/laptop01.jpeg "Laptop's screenshot 01")
![Laptop's screenshot 02!](media/screenshots/laptop02.jpeg "Laptop's screenshot 02")
![phone's screenshot 01!](media/screenshots/phone01.png "Phone's screenshot 01")
# requirement
* A Text Editor
* Python
* Web Browser
- A Text Editor
- Python
- Web Browser
# How to use
* First of edit the sites.xml, change every thing in CAPS, add as many as you like
- First of edit the sites.xml, change every thing in CAPS, add as many as you like
```
<item name = "NAME">
<tag>TAG</tag>
@ -31,23 +36,23 @@ I just wanted to make my own dashboard for my homelab and used the things i know
</item>
```
** for <tag> use or however you like (this affect the colors of the cards):
*** "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
-- for <tag> use or however you like (this affect the colors of the cards):
--- "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
** Run the python script to create your index.html
- Run the python script to create your index.html
`python main.py`
** put the files in your webserver or just open it in your web browser
- put the files in your webserver or just open it in your web browser
# Used stuff
things used here:
* HTML
* CSS
* Bootstrap & jQuery
* ["This script for the search" "https://stackoverflow.com/a/61621522"]
* Nord Colors
* Python
- HTML
- CSS
- Bootstrap & jQuery
- [This script for the search](https://stackoverflow.com/a/61621522)
- Nord Colors
- Python