pino/sillyhome-next
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 47 Wiki Activity

DOC-QUALITY-001: Quickstart mit ENV-Konfiguration dokumentieren #5

New Issue
Closed
opened 2026-06-10 21:16:37 +02:00 by Otto · 3 comments
Otto commented 2026-06-10 21:16:37 +02:00
Collaborator
Copy Link

Problem

Nach der Settings-Reparatur ist klar, welche ENV-Variablen nötig sind, aber README/Quickstart beschreibt sie noch nicht ausreichend.

Vorschlag

  • .env.example ergänzen.
  • README Quickstart für lokalen API-Start und HA-Konfiguration.
  • Hinweis auf lokal-first und Secret-Handhabung.

Akzeptanz

  • Neuer Entwickler kann API starten und /health, /docs, /v1/entities testen.
## Problem Nach der Settings-Reparatur ist klar, welche ENV-Variablen nötig sind, aber README/Quickstart beschreibt sie noch nicht ausreichend. ## Vorschlag - `.env.example` ergänzen. - README Quickstart für lokalen API-Start und HA-Konfiguration. - Hinweis auf lokal-first und Secret-Handhabung. ## Akzeptanz - Neuer Entwickler kann API starten und `/health`, `/docs`, `/v1/entities` testen.
Otto added the qualitydocumentation labels 2026-06-10 21:16:37 +02:00
pino commented 2026-06-10 21:45:25 +02:00
Owner
Copy Link

Plan für Issue #5 - Quickstart ENV-Doku

Ziel: Entwickler können API lokal starten und /health, /docs, /v1/entities ohne Rätsel testen.

Schritte:

  1. .env.example mit SILLYHOME_HA_URL und SILLYHOME_HA_TOKEN anlegen.
  2. README-Quickstart erweitern: Installation, Start, ENV-Doku, Aufruf /health und /v1/entities.
  3. Hinweis: Secret lokal halten, nicht committen, .gitignore beachten.

Akzeptanz:

  • cp .env.example .env + Einträge setzen reicht für ersten Lauf.
  • README zeigt Minimalanleitung in <5 Minuten.
**Plan für Issue #5 - Quickstart ENV-Doku** **Ziel:** Entwickler können API lokal starten und `/health`, `/docs`, `/v1/entities` ohne Rätsel testen. **Schritte:** 1. `.env.example` mit `SILLYHOME_HA_URL` und `SILLYHOME_HA_TOKEN` anlegen. 2. README-Quickstart erweitern: Installation, Start, ENV-Doku, Aufruf `/health` und `/v1/entities`. 3. Hinweis: Secret lokal halten, nicht committen, `.gitignore` beachten. **Akzeptanz:** - `cp .env.example .env` + Einträge setzen reicht für ersten Lauf. - README zeigt Minimalanleitung in <5 Minuten.
Otto commented 2026-06-10 22:00:15 +02:00
Author
Collaborator
Copy Link

Umgesetzt in PR #7: .env.example, README-Quickstart, HA-ENV-Variablen, lokale Start-/Check-Kommandos und Secret-Hinweise ergänzt. Lokal verifiziert zusammen mit dem Code-Stand.

Umgesetzt in PR #7: `.env.example`, README-Quickstart, HA-ENV-Variablen, lokale Start-/Check-Kommandos und Secret-Hinweise ergänzt. Lokal verifiziert zusammen mit dem Code-Stand.
pino closed this issue 2026-06-11 00:12:13 +02:00
pino commented 2026-06-11 03:48:52 +02:00
Owner
Copy Link

Implementierung abgeschlossen:

  • Branch feature/doc-005-quickstart-env gepusht (Commit f4f2379)
  • .env.example hinzugefügt (musste wegen .gitignore-Regel .env.* mit -f hinzugefügt werden – wir sollten die Regel anpassen, um .env.example zu erlauben)
  • README-Quickstart-Sektion ergänzt: Installation, Start, ENV-Doku, Prüfung, Tests

PR-Vorschlag: http://192.168.6.31:3000/pino/sillyhome-next/pulls/new/feature/doc-005-quickstart-env

Akzeptanz prüfen: Neuer Entwickler kann API starten und /health, /docs, /v1/entities testen.

Implementierung abgeschlossen: - Branch `feature/doc-005-quickstart-env` gepusht (Commit f4f2379) - `.env.example` hinzugefügt (musste wegen `.gitignore`-Regel `.env.*` mit `-f` hinzugefügt werden – wir sollten die Regel anpassen, um `.env.example` zu erlauben) - README-Quickstart-Sektion ergänzt: Installation, Start, ENV-Doku, Prüfung, Tests PR-Vorschlag: http://192.168.6.31:3000/pino/sillyhome-next/pulls/new/feature/doc-005-quickstart-env Akzeptanz prüfen: Neuer Entwickler kann API starten und `/health`, `/docs`, `/v1/entities` testen.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
architecture
backend
bug
documentation
feature
frontend
home-assistant
machine-learning
operations
pino
quality
tests
No Label documentation quality
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Oskar Otto pino
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: pino/sillyhome-next#5
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?