help-14/magma

Personal dashboard that is highly customizable, lightweight and responsive

Magma dashboard 🌋

Personal dashboard that is highly customizable, lightweight and responsive.

Features

• Lightweight (8-16Mb), fast, build from Go
• Support multiple languages
• Support multiple themes
• Addons support (WIP)

How to use

• Download our 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

Customization

Go to our website 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
• ramatov-zulfikor for simplenord

Cloudflare Pages

If you don't want to selfhost and have maximum speed, checkout this version: CF-Magma

magma's Issues

Making website using docsify

• Writing website / document
• Automate with github action and github pages build

https://docsify.js.org/#/

Convert flame theme into tailwindcss

Theme requests

If you have an idea for a theme and don't know how to code, make a picture mockup and post it here, someone will help you (maybe) :)

Compile index file to static html page

Currently Magma will load data.json on page load and inject html code to the page.
After task #1 completed, we can add html code directly to index.html file in temp folder when data.json changed.
It will improve page load speed and save bandwidth.

Improvement requests

Any suggestions or improvement are welcomed, post your feedback down here :)

Using github action to automate Docker build

Recompile website when file changed in public folder

When a file in public folder changes, copy it to temp folder and minify it.
Using deno system events to detect file changed: https://deno.land/[email protected]/examples/file_system_events

UI improvement

• Fixing margin / padding inconsistency
• Background picture is not cover all area some time
• Add fade in animation after bookmark loaded

Change server into other framework

Deno is not working on ARM right now, researching different server implementation.