Allgemeine Einführung
GitPodcast ist ein innovatives Tool, das GitHub-Repositories in Podcasts verwandelt und es Entwicklern ermöglicht, jederzeit und überall Code-Updates zu hören. Mithilfe von OpenAI und dem Azure Speech SDK generiert GitPodcast Audio-Zusammenfassungen von Commits, Pull-Requests, Meilensteinen und mehr aus GitHub-Repositories und ermöglicht es Entwicklern, Projekt-Updates zu erhalten, wenn sie nicht die Möglichkeit haben, Code zu lesen. Egal, ob Sie pendeln, trainieren oder eine Pause machen, GitPodcast hilft Entwicklern, unterwegs über Codeänderungen informiert zu bleiben.
Funktionsliste
- GitHub-Repository rebroadcasterGenerieren Sie Audiozusammenfassungen von Commit-Logs, Pull-Requests und Meilensteinen aus GitHub-Repositories.
- AI-Audio-GenerierungAutomatisches Generieren von Audioinhalten mithilfe von KI-Technologie, um eine effiziente Möglichkeit zur Aktualisierung des Codes zu bieten.
- MultitaskingUnterstützt Entwickler dabei, sich über den Fortschritt ihrer Projekte per Audio zu informieren, während sie an anderen Aufgaben arbeiten.
- AnpassungsmöglichkeitenAuswahl an verschiedenen Stimmen (in Entwicklung)
- API-ZugangÖffentliche APIs für die Integration bereitstellen (in Entwicklung)
- nahtlose Integration: Verbinden Sie einfach Ihr GitHub-Konto und schon können Sie loslegen.
- Völlig kostenlosEs werden keine Gebühren oder Abonnements verlangt und der Dienst wird kostenlos angeboten.
Hilfe verwenden
Installation und Einrichtung
- Klon-Lager::
git clone https://github.com/BandarLabs/gitpodcast.git cd gitpodcast
- Installation von Abhängigkeiten::
pnpm i
- Setzen von Umgebungsvariablen::
cp .env.example .env
Compiler
.env
Datei, fügen Sie Ihre Anthropisch API-Schlüssel und ein optionales persönliches GitHub-Zugangs-Token.
Ausführen des Backends
- Starten des Docker-Containers::
docker-compose up --build -d
Die Protokolle können mit dem folgenden Befehl angezeigt werden:
docker-compose logs -f
Der FastAPI-Server läuft auf dem
localhost:8000
. - Starten der lokalen Datenbank::
chmod +x start-database.sh . /start-database.sh
Wenn Sie aufgefordert werden, ein zufälliges Passwort zu generieren, geben Sie ein
ja
Die Postgres-Datenbank wird auf demlocalhost:5432
. - Initialisierung der Datenbankarchitektur::
pnpm db:push
Sie können die Datenbank mit den folgenden Befehlen anzeigen und mit ihr interagieren:
pnpm db:studio
Betrieb des Frontends
- Starten Sie den Front-End-Entwicklungsserver::
pnpm-Entwicklung
Sie können nun die Ergebnisse in der
localhost:3000
Besuchen Sie die Website undbackend/app/routers/generate.py
Datei, um die im Dekorator der Generatorfunktion definierte Ratengrenze zu bearbeiten.
Wie man mit GitPodcast anfängt
- Verbinden Sie Ihr GitHub-Konto::
- Besuchen Sie die GitPodcast-Website (https://www.gitpodcast.com/).
- Klicken Sie auf die Schaltfläche "GitHub-Konto verbinden" und folgen Sie den Aufforderungen zur Autorisierung.
- Sobald die Autorisierung abgeschlossen ist, ruft GitPodcast automatisch die Informationen zu Ihrem GitHub-Repository ab.
- Audiozusammenfassungen generieren::
- Wählen Sie das GitHub-Repository auf der GitPodcast-Website aus, von dem Sie die Audiozusammenfassung erstellen möchten.
- Klicken Sie auf die Schaltfläche "Podcast generieren", und AI erstellt automatisch eine Audiozusammenfassung des Repositorys.
- Die erstellte Audiozusammenfassung wird in Ihrer Podcast-Liste angezeigt.
- Hören Sie sich die Audiozusammenfassung an::
- Wählen Sie in der Podcast-Liste die Audiozusammenfassung aus, die Sie anhören möchten.
- Klicken Sie auf die Schaltfläche "Abspielen", um die Code-Aktualisierung anzuhören.
- Sie können unterwegs über Ihre Kopfhörer hören, während Sie pendeln, trainieren oder eine Pause machen.
Detaillierte Funktionsabläufe
- Verbinden Sie Ihr GitHub-Konto::
- Öffnen Sie die GitPodcast-Website und klicken Sie auf der Startseite auf die Schaltfläche "GitHub-Konto verbinden".
- Sie werden auf die GitHub-Autorisierungsseite weitergeleitet, wo Sie Ihre GitHub-Kontoinformationen eingeben und Ihr Konto autorisieren können.
- Nach erfolgreicher Autorisierung leitet das System Sie zur GitPodcast-Website mit einer Liste Ihrer GitHub-Repositories zurück.
- Auswahl von Repositories und Erstellung von Audiozusammenfassungen::
- Durchsuchen Sie Ihre Liste der GitHub-Repositories auf der GitPodcast-Website.
- Wählen Sie das Repository aus, für das Sie eine Audiozusammenfassung erstellen möchten, und klicken Sie auf die Schaltfläche "Podcast generieren".
- Das System analysiert automatisch die Commit-Logs, Pull-Requests und Milestones für dieses Warehouse und erstellt eine Audiozusammenfassung.
- Hören Sie sich die Audiozusammenfassung an::
- Suchen Sie in der Podcast-Liste die Audiozusammenfassung, die Sie anhören möchten.
- Klicken Sie auf die Schaltfläche "Abspielen", um die Wiedergabe zu starten.
- Sie können Code-Updates unterwegs mit Kopfhörern oder Audiogeräten anhören.
- Verwalten von Podcasts::
- Sie können Ihre Podcast-Einträge auf der GitPodcast-Website verwalten.
- Löschen Sie unerwünschte Audiozusammenfassungen oder generieren Sie neue Zusammenfassungen.
- Halten Sie Ihre Podcast-Listen mit einfachen Aktionen übersichtlich und organisiert.
GitPodcast bietet Entwicklern eine effiziente und bequeme Möglichkeit, trotz ihres hektischen Alltags über ihre Projekte auf dem Laufenden zu bleiben. Mit Audiozusammenfassungen, die durch KI-Technologie generiert werden, können Entwickler jederzeit und überall über Code-Updates auf dem Laufenden bleiben und ihre Produktivität steigern.