Initial commit: Docker Dashboard with Next.js and Netbox integration
This commit is contained in:
62
README.md
Normal file
62
README.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Docker Dashboard (Netbox Integration)
|
||||
|
||||
Ein modernes Dashboard zur Visualisierung von Docker-Containern und Inventar-Daten, integriert mit Netbox. Entwickelt mit Next.js, React und Tailwind CSS.
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- **Inventar-Übersicht**: Darstellung von Container-Informationen.
|
||||
- **Netbox Integration**: Nahtlose Anbindung an die Netbox API.
|
||||
- **Modernes UI**: Responsives Design dank Tailwind CSS v4.
|
||||
- **Dockerized**: Einfaches Deployment via Docker Compose.
|
||||
|
||||
## 🛠️ Technologien
|
||||
|
||||
- **Frontend**: [Next.js 16](https://nextjs.org/), [React 19](https://react.dev/)
|
||||
- **Styling**: [Tailwind CSS 4](https://tailwindcss.com/), Lucide React Icons
|
||||
- **Deployment**: Docker & Docker Compose
|
||||
|
||||
## 📦 Installation & Setup
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Docker & Docker Compose
|
||||
- Zugriff auf eine Netbox-Instanz (API URL & Token)
|
||||
|
||||
### Starten mit Docker Compose
|
||||
|
||||
1. **Repository klonen** (oder Dateien herunterladen).
|
||||
|
||||
2. **Umgebungsvariablen konfigurieren**:
|
||||
Erstelle eine `.env` Datei im Hauptverzeichnis oder nutze die bestehende.
|
||||
|
||||
```env
|
||||
NETBOX_API_URL=https://deine-netbox-url.com
|
||||
NETBOX_API_TOKEN=dein_api_token
|
||||
APP_TITLE="Mein Docker Dashboard"
|
||||
```
|
||||
|
||||
3. **Container starten**:
|
||||
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
```
|
||||
|
||||
Das Dashboard ist nun unter `http://localhost:3000` erreichbar.
|
||||
|
||||
## 🔧 Entwicklung
|
||||
|
||||
Um das Frontend lokal ohne Docker zu entwickeln:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 📂 Projektstruktur
|
||||
|
||||
- `docker-compose.yml`: Definition der Services.
|
||||
- `frontend/`: Quellcode der Next.js Anwendung.
|
||||
- `src/app/`: Next.js App Router Pages.
|
||||
- `src/lib/`: Hilfsfunktionen und API-Clients.
|
||||
- `src/components/`: UI-Komponenten.
|
||||
Reference in New Issue
Block a user