beenull
/
home-dashboard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add badge and demo link

This commit is contained in:
Carlo Mandelli 2021-08-08 10:12:42 +02:00
parent 76b0a81b07
commit f0f8b800ba
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,5 +1,7 @@
# Home Dashboard
[![Release](https://github.com/camandel/home-dashboard/actions/workflows/release.yml/badge.svg)](https://github.com/camandel/home-dashboard/actions/workflows/release.yml)
**Home Dashboard** is a simple startpage to keep track of your favourite servers, applications, links and personal tasks. It can be used as your default browser starting page.
This project is based on [SUI](https://github.com/jeroenpardon/sui).
@ -7,6 +9,9 @@ This project is based on [SUI](https://github.com/jeroenpardon/sui).
<img src="assets/screenshot.jpg?raw=true" alt="screenshot"/>
</p>
## Try it
Live demo [here](https://camandel.github.io/home-dashboard/)
## Features
- single page application
- TODO tasks list
@ -36,9 +41,9 @@ mv home-dashboard /var/www/html && systemctl start httpd
```
cd home-dashboard && python -m http.server
```
If you don't want to setup a web server you can use directly the tiny docker image (only 32 KB) which contains the code and an http server listening on port 8000:
If you don't want to setup a web server you can use directly the tiny docker image (only 31 KB) which contains the code and an http server listening on port 8000:
```
docker run --name home-dashboard -v $PWD/conf:/www/conf -p 8000:8000 -d camandel/home-dashboard
docker run --name home-dashboard -v <your-volume-or-local-dir>:/www/conf -p 8000:8000 -d camandel/home-dashboard
```
## Configuration