diff --git a/README.md b/README.md index 2be65ea..e3efab5 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,37 @@ # Magma Dashboard + Personal dashboard that is highly customizable, lightweight and responsive. ![Magma dashboard preview](./docs/screenshots/flame.png) ## Features -* Lightweight (8-16Mb), fast, build from Go -* Support multiple [languages](https://magma.help14.com/#/customization/languages) -* Support multiple [themes](https://magma.help14.com/#/customization/themes) -* Addons support (WIP) + +- Lightweight (8-16Mb), fast, build from Go +- Support multiple [languages](https://magma.help14.com/#/customization/languages) +- Support multiple [themes](https://magma.help14.com/#/customization/themes) +- Addons support (WIP) ## How to use -* Download our [docker-compose.yml](./docker-compose.yml) file -* Start with `docker-compose up -d` -* Go to `data/config.yaml` to config your dashboard -* Go to `data/data.yaml` to edit your bookmarks -* See your dashboard at [localhost:7001](http://localhost:7001) + +- Download our [docker-compose.yml](./docker-compose.yml) file +- Start with `docker-compose up -d` +- Go to `data/config.yaml` to config your dashboard +- Go to `data/data.yaml` to edit your bookmarks +- See your dashboard at [localhost:7001](http://localhost:7001) [![Magma on Docker Hub](https://dockeri.co/image/help14/magma)](https://hub.docker.com/r/help14/magma) ## Customization -Go to our [website](https://magma.help14.com) and read the document to learn more. + +Go to our [website](https://magma.help14.com) and read the document to learn more. ## Contribution + Contributions welcome and needed! ## Thanks to -- pawelmalak for flame -- migueravila for simplefox -- u/Goldtom for flame css theme + +- pawelmalak for [flame](https://github.com/pawelmalak/flame) +- migueravila for [simplefox](https://github.com/migueravila/SimpleFox) +- u/Goldtom for [flame css theme](https://www.reddit.com/r/selfhosted/comments/rbb4kk/flame_dashboard_custom_css_tweaks/) +- ramatov-zulfikor for [simplenord](https://github.com/ramatov-zulfikor/startpage) diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 69c1999..0000000 --- a/docs/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Magma Dashboard -Personal dashboard that is highly customizable, lightweight and responsive. - -[![Magma on Docker Hub](https://dockeri.co/image/help14/magma)](https://hub.docker.com/r/help14/magma) - -## Features -* Lightweight (8-16Mb), fast, build from Go -* Support multiple [languages](./customization/languages.md) -* Support multiple [themes](./customization/themes.md) -* Addons support (WIP) \ No newline at end of file diff --git a/docs/customization/themes.md b/docs/customization/themes.md index b70a343..185727b 100644 --- a/docs/customization/themes.md +++ b/docs/customization/themes.md @@ -6,8 +6,12 @@ ## simplefox -![Simplefox theme](../screenshots/simplefox.png) +![Simple fox theme](../screenshots/simplefox.png) + +## simplenord + +![Simple nord theme](../screenshots/simplenord.png) ## leaf -![Leaf theme](../screenshots/leaf.png) \ No newline at end of file +![Leaf theme](../screenshots/leaf.png) diff --git a/docs/screenshots/flame.png b/docs/screenshots/flame.png index ebcc4e1..bd7eac2 100644 Binary files a/docs/screenshots/flame.png and b/docs/screenshots/flame.png differ diff --git a/docs/screenshots/simplefox.png b/docs/screenshots/simplefox.png index e3f638e..2aa69c9 100644 Binary files a/docs/screenshots/simplefox.png and b/docs/screenshots/simplefox.png differ diff --git a/docs/screenshots/simplenord.png b/docs/screenshots/simplenord.png new file mode 100644 index 0000000..505bd70 Binary files /dev/null and b/docs/screenshots/simplenord.png differ diff --git a/sample/simplenord/config.yaml b/sample/simplenord/config.yaml new file mode 100644 index 0000000..952f3ca --- /dev/null +++ b/sample/simplenord/config.yaml @@ -0,0 +1,13 @@ +website: + theme: "simplenord" + title: "Magma Dashboard" + description: "" + language: "en" + localization: "en-US" + useMetric: true +openweathermap: + apiKey: demo + lon: 0 + lat: 0 +addons: + - docker diff --git a/sample/simplenord/css/core.css b/sample/simplenord/css/core.css new file mode 100644 index 0000000..8172027 --- /dev/null +++ b/sample/simplenord/css/core.css @@ -0,0 +1,6 @@ +:root { + --bgColor: #2e3440; + --bgImage: url("/theme/images/art.jpg"); + --accentColor: #88c0d0; + --foreground: #d8dee9; +} \ No newline at end of file diff --git a/sample/simplenord/data.yaml b/sample/simplenord/data.yaml new file mode 100644 index 0000000..a1270c1 --- /dev/null +++ b/sample/simplenord/data.yaml @@ -0,0 +1,49 @@ +data: + - title: Applications + columns: + - title: Servers + bookmarks: + - name: OpenWRT + icon: fa-solid fa-wifi + url: https://openwrt.org + - name: Proxmox + icon: https://iconape.com/wp-content/files/pk/18549/svg/cib-proxmox.svg + url: https://www.proxmox.com/en/ + - name: Home Assistant + icon: fa-solid fa-house + url: https://www.home-assistant.io + - name: Docker + icon: fa-brands fa-docker + url: https://www.docker.com + - title: Nas + bookmarks: + - name: TrueNas + icon: fa-solid fa-server + url: https://www.truenas.com + - name: Kerberos + icon: fa-solid fa-video + url: https://kerberos.io + - name: jDownloader + icon: fa-solid fa-cloud-arrow-down + url: https://jdownloader.org + - title: Bookmarks + columns: + - title: Social Media + bookmarks: + - name: Facebook + icon: fa-brands fa-facebook + url: https://www.facebook.com + - name: Reddit + icon: fa-brands fa-reddit + url: https://www.reddit.com + - name: Youtube + icon: fa-brands fa-youtube + url: https://www.youtube.com + - title: Shopping + bookmarks: + - name: Shopee + icon: fa-solid fa-bag-shopping + url: https://shopee.vn + - name: Lazada + icon: fa-brands fa-amazon + url: https://www.amazon.com diff --git a/src/themes/simplenord/css/style.min.css b/src/themes/simplenord/css/style.min.css new file mode 100644 index 0000000..d431fe8 --- /dev/null +++ b/src/themes/simplenord/css/style.min.css @@ -0,0 +1,168 @@ +@import url("../fonts/fonts.css"); + +:root { + --text-hover-color: #81a1c1 +} + +*, +*::before, +*::after { + margin: 0; + padding: 0; + -webkit-box-sizing: border-box; + box-sizing: border-box +} + +html, +body { + height: 100% +} + +body { + font-family: 'Fira Mono'; + color: var(--foreground); + background-color: var(--bgColor) +} + +#cover-art { + content: var(--bgImage); +} + +.wrapper { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-orient: vertical; + -webkit-box-direction: normal; + -ms-flex-direction: column; + flex-direction: column; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + -webkit-box-pack: center; + -ms-flex-pack: center; + justify-content: center; + height: 100% +} + +.box { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + padding: 15px 30px 15px 15px; + border: 1px solid var(--foreground) +} + +.box__image { + margin-right: 30px +} + +.box__image img { + display: block; + width: 300px; + height: 300px; + -o-object-fit: cover; + object-fit: cover +} + +.box__title { + font-weight: 400; + font-size: 28px; + margin-bottom: 25px +} + +.box__links { + display: -webkit-box; + display: -ms-flexbox; + display: flex +} + +.links { + list-style: none +} + +.links:not(:last-child) { + margin-right: 50px +} + +.links__heading { + font-size: 18px; + color: #88c0d0 +} + +.links__item:first-child { + margin-bottom: 10px +} + +.links__item:not(:first-child) { + margin-top: 5px +} + +.links__link { + font-size: 16px; + line-height: 150%; + color: inherit; + text-decoration: none; + -webkit-transition: color 0.2s linear; + -o-transition: color 0.2s linear; + transition: color 0.2s linear +} + +.links__link:hover { + color: var(--text-hover-color) +} + +@media (max-width: 991.98px) { + .box { + padding: 20px + } + + .box__image { + display: none + } +} + +@media (max-width: 767.98px) { + .wrapper { + -webkit-box-align: start; + -ms-flex-align: start; + align-items: start; + -webkit-box-pack: start; + -ms-flex-pack: start; + justify-content: start + } + + .box { + width: 100%; + border: none + } + + .box__content { + width: 100% + } + + .box__links { + -ms-flex-wrap: wrap; + flex-wrap: wrap + } + + .links { + -webkit-box-flex: 0; + -ms-flex: 0 0 50%; + flex: 0 0 50%; + margin-bottom: 30px + } + + .links:not(:last-child) { + margin-right: 0 + } +} + +@media (max-width: 575.98px) { + .box { + padding: 15px + } +} \ No newline at end of file diff --git a/src/themes/simplenord/fonts/FiraMono-Regular.eot b/src/themes/simplenord/fonts/FiraMono-Regular.eot new file mode 100644 index 0000000..969aaae Binary files /dev/null and b/src/themes/simplenord/fonts/FiraMono-Regular.eot differ diff --git a/src/themes/simplenord/fonts/FiraMono-Regular.ttf b/src/themes/simplenord/fonts/FiraMono-Regular.ttf new file mode 100644 index 0000000..9b45377 Binary files /dev/null and b/src/themes/simplenord/fonts/FiraMono-Regular.ttf differ diff --git a/src/themes/simplenord/fonts/FiraMono-Regular.woff b/src/themes/simplenord/fonts/FiraMono-Regular.woff new file mode 100644 index 0000000..01d6a62 Binary files /dev/null and b/src/themes/simplenord/fonts/FiraMono-Regular.woff differ diff --git a/src/themes/simplenord/fonts/FiraMono-Regular.woff2 b/src/themes/simplenord/fonts/FiraMono-Regular.woff2 new file mode 100644 index 0000000..a56e756 Binary files /dev/null and b/src/themes/simplenord/fonts/FiraMono-Regular.woff2 differ diff --git a/src/themes/simplenord/fonts/fonts.css b/src/themes/simplenord/fonts/fonts.css new file mode 100644 index 0000000..ff7366e --- /dev/null +++ b/src/themes/simplenord/fonts/fonts.css @@ -0,0 +1,9 @@ +@font-face { + font-family: 'Fira Mono'; + src: url('FiraMono-Regular.eot'); + src: local('Fira Mono Regular'), local('FiraMono-Regular'), + url('FiraMono-Regular.eot?#iefix') format('embedded-opentype'), url('FiraMono-Regular.woff2') format('woff2'), + url('FiraMono-Regular.woff') format('woff'), url('FiraMono-Regular.ttf') format('truetype'); + font-weight: normal; + font-style: normal; +} diff --git a/src/themes/simplenord/images/art.jpg b/src/themes/simplenord/images/art.jpg new file mode 100644 index 0000000..03e45fb Binary files /dev/null and b/src/themes/simplenord/images/art.jpg differ diff --git a/src/themes/simplenord/index.html b/src/themes/simplenord/index.html new file mode 100644 index 0000000..51abc3e --- /dev/null +++ b/src/themes/simplenord/index.html @@ -0,0 +1,71 @@ + + + + + + {{.Config.Title}} + + + + + + + + + + +
+
+
+ Abstract art +
+
+

+
+ {{range .Contents}} + {{range .Columns}} +
    +
  • + {{.Title}} +
    • + {{range .Bookmarks}} +
  • + {{.Name}} +
    • + {{end}} +
+ {{end}} + {{end}} +
+
+
+
+ + + + + + + \ No newline at end of file