Singularity

Have all your stuff in one place. That's right 😌 — all in your Singularity.

Singularity is a customizable dashboard powered by a templating engine with data injection and built-in parallelism for faster rendering 😅. It features a shared cache for even greater speed ⚡ — all crafted in Rust 🦀.

---

📌 Table of Contents

• 📥 Installation
• ⚙️ Configuration
• 📑 Preconfigured Pages
• 🎨 Themes
• 🔥 Features
• 🐎 Profiling

---

🔥 Features

📌 Widgets

• Weather 🌤️
• Clock ⏰
• Calendar 🗓️
• Header Widget
• More widgets coming soon!

⚡ Shared Cache

Singularity features a shared cache enabled by default, with a Time-To-Live (TTL) of 5 minutes. This improves performance by reducing redundant fetches.

🛠️ Configuring TTL in singularity.yaml

theme: neo-noir
theme_background_color: "black"
widget_heading: "white"
footer: "yellow"
cache: 5m

✅ Supported Formats:

• 10m → 10 minutes
• 2h → 2 hours
• 0.5h → 30 minutes
• 0.5m → 30 seconds

⚠️ NOTE: Minimum TTL is 10 seconds. If set below this, the system defaults to 5 minutes.

📊 Header Widget

A special monitoring widget that displays system stats. Enable it for each page with:

header-widget: true

📡 Displays:

• CPU Usage 🖥
• Number of Cores 🧇
• Wi-Fi Status 🛜
• OS Info 💽
• Username 🖥️
• Available Mounts & Disk Space

---

📥 Installation

🪟 Windows

Prerequisites

• rustc
• Cargo
• rustup

Install & Run

git clone https://github.com/AMS003010/Singularity.git
cd Singularity
cargo r -r

🐧 Linux (Tested on Ubuntu 24.04 LTS)

Install & Run

git clone https://github.com/AMS003010/Singularity.git
cd Singularity/scripts/
chmod +x install-linux.sh
mv install-linux.sh ../
cd ..
./install-linux.sh

Then, run:

singularity

📦 Run as a Container

Prerequisites

• Docker

Install & Run

git clone https://github.com/AMS003010/Singularity.git
cd Singularity
docker compose up

---

📊 Activity

---

🐎 Profiling

Optimize performance with samply:

cargo install samply --locked
cargo build && samply record target/release/singularity

---

⚠️ Caution

This project is under active development. Expect occasional breakages 😑.

🌟 Inspired by Glance

---

👨‍💻 Maintainers This project is maintained by @AMS003010.

🤝 Contributing We welcome contributions to Twilight! To contribute:

Fork the repository. Create a new branch (feature-branch). Commit your changes. Push to your branch and open a pull request. 📝 License This project is licensed under the MIT License.

📩 Contact For any queries or issues, feel free to reach out via GitHub Issues.

Happy Coding! 🚀