update readme
All checks were successful
Nix Build / build (push) Successful in 1m11s

This commit is contained in:
Joakim Repomaa
2026-02-22 23:05:41 +02:00
parent 7a3768e1bf
commit 0ca657beb1

View File

@@ -1,42 +1,53 @@
# sv
# Router Dash
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
[![Nix Build](https://git.freun.dev/repomaa/router-dash/actions/workflows/build.yaml/badge.svg)](https://git.freun.dev/repomaa/router-dash/actions?workflow=build.yaml)
## Creating a project
A modern web dashboard for monitoring network interfaces, routes, and DHCP leases. Built with SvelteKit 5 and designed to work with systemd-networkd's JSON output.
If you're seeing this, you've probably already done this step. Congrats!
## Features
- **Network Interface Monitoring** - View detailed interface information including IP addresses, routes, carrier state, and operational status
- **DHCP Lease Management** - Display active and expired DHCP leases with time remaining
- **Routing Table Visualization** - Show routing policies and network routes
- **Real-time Status** - Monitor operational states, carrier states, and address states
- **Responsive Design** - Clean, modern UI built with Tailwind CSS
## Tech Stack
- **Framework**: SvelteKit 5 with Svelte 5 runes
- **Language**: TypeScript (strict mode)
- **Styling**: Tailwind CSS 4
- **Icons**: Lucide Svelte
- **Build**: Vite
- **CI/CD**: Gitea Actions with Nix
## Development
```sh
# create a new project
npx sv create my-app
```
# Install dependencies
npm install
To recreate this project with the same configuration:
```sh
# recreate this project
deno run npm:sv create --template minimal --types ts --add prettier eslint tailwindcss="plugins:none" sveltekit-adapter="adapter:static" devtools-json mcp="ide:opencode+setup:local" --install deno router-dash
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```sh
# Start development server
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
# Type check
npm run check
# Lint and format
npm run lint
npm run format
```
## Building
To create a production version of your app:
```sh
# Create production build
npm run build
# Preview production build
npm run preview
```
You can preview the production build with `npm run preview`.
## License
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
AGPL-3.0-or-later