Add templates, README, and license to initialize project essentials

This commit is contained in:
Arindy 2025-12-28 15:20:07 +01:00
parent a83958500e
commit 3442864fbe
4 changed files with 112 additions and 0 deletions

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Arindy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

72
README.md Normal file
View File

@ -0,0 +1,72 @@
# ArinDash
ArinDash is a customizable terminal dashboard (TUI) written in Go, powered by [`termdash`](https://github.com/mum4k/termdash). It allows you to monitor various services, network devices, and system information in a single terminal view.
## Features
- **Clock & Date**: Real-time time and date display.
- **Pi-hole Integration**: Monitor your Pi-hole statistics, including query counts and blocked percentages.
- **Docker Monitoring**: View the status of your Docker containers.
- **HTTP Prober**: Check the availability and status codes of your favorite websites.
- **Network Device Monitoring**: Track which devices are online in your local network.
- **WiFi QR Code**: Display a QR code for easy WiFi connection sharing.
- **Interactive TUI**: Built with `termdash` for a responsive and visually appealing terminal interface.
## Prerequisites
- **Go**: Version 1.25.5 or later.
- **Docker**: If you want to use the Docker monitoring widget.
- **Nerd Fonts**: Recommended for displaying icons correctly in the terminal. You can find icons at the [Nerd Fonts Cheat Sheet](https://www.nerdfonts.com/cheat-sheet).
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/ArinDash.git
cd ArinDash
```
2. Install dependencies:
```bash
go mod download
```
## Configuration
ArinDash uses a `config.toml` file for its settings. A template is provided as `config_template.toml`.
1. Copy the template:
```bash
cp config_template.toml config.toml
```
2. Edit `config.toml` with your specific details:
- **Pi-hole**: Set your host and API password.
- **WiFi**: Configure your SSID and password for the QR code widget.
3. Customize widgets:
- **Websites**: Copy `websites_template.json` to `websites.json` and update it with the URLs and icons you want to monitor.
- **Network Devices**: Copy `devices_template.json` to `devices.json` and configure it with the MAC addresses and names of the devices you want to track.
## Usage
To run ArinDash, simply execute:
```bash
go run main.go
```
### Controls
- **Esc / Ctrl+C**: Exit the application.
## Project Structure
- `main.go`: Entry point and layout definition.
- `widgets/`: Contains individual widget implementations (Clock, Docker, Pi-hole, etc.).
- `apis/`: API clients for interacting with external services (Docker, Pi-hole, etc.).
- `config/`: Configuration loading logic.
- `util/`: Helper functions and utilities.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

9
devices_template.json Normal file
View File

@ -0,0 +1,9 @@
{
"00:00:00:00:00:00": {
"name": "Sample Device",
"ip": "192.168.1.10",
"interface": "",
"icon": "󰄜",
"online": false
}
}

10
websites_template.json Normal file
View File

@ -0,0 +1,10 @@
[
{
"url": "https://google.com",
"icon": "󰊭"
},
{
"url": "https://github.com",
"icon": "󰊤"
}
]