docs: README mit Projektübersicht und Architektur #1

Closed
andreas.dinauer wants to merge 1 commits from docs/readme-overview into main
Owner

Die README war noch der Nuxt-Standard-Boilerplate-Text. Hab sie durch echte Doku ersetzt:

  • Kurzbeschreibung, was das Tool eigentlich macht (S3-Bucket-Browser mit Upload/Download/Delete)
  • Architektur-Überblick über Components/Composables/Utils
  • Erklärung wie das SigV4-Signing und der S3-Client funktionieren
  • Setup- und Dev-Anleitung inkl. .env
  • Build/Deploy-Hinweis zur Jenkins-Pipeline
  • Abschnitt "Bekannte Lücken" — u.a. dass "Bucket erstellen" noch ein Mock ist, keine Pagination bei großen Buckets, und dass der Secret Key aktuell im Client-Bundle landet (für internes Tool ok, aber sollte man im Hinterkopf behalten)

Kein Code geändert, nur README.md.

Die README war noch der Nuxt-Standard-Boilerplate-Text. Hab sie durch echte Doku ersetzt: - Kurzbeschreibung, was das Tool eigentlich macht (S3-Bucket-Browser mit Upload/Download/Delete) - Architektur-Überblick über Components/Composables/Utils - Erklärung wie das SigV4-Signing und der S3-Client funktionieren - Setup- und Dev-Anleitung inkl. `.env` - Build/Deploy-Hinweis zur Jenkins-Pipeline - Abschnitt "Bekannte Lücken" — u.a. dass "Bucket erstellen" noch ein Mock ist, keine Pagination bei großen Buckets, und dass der Secret Key aktuell im Client-Bundle landet (für internes Tool ok, aber sollte man im Hinterkopf behalten) Kein Code geändert, nur README.md.
andreas.dinauer added 1 commit 2026-09-10 20:05:37 +00:00
andreas.dinauer closed this pull request 2026-09-11 19:56:19 +00:00
andreas.dinauer deleted branch docs/readme-overview 2026-09-11 19:56:19 +00:00

Pull request closed

This pull request cannot be reopened because the branch was deleted.
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: r9t/frontend#1