Allgemeine Einführung
Audibit ist ein Open-Source-Projekt, dessen Kernfunktion darin besteht, populäre Tech-Artikel wie Hacker News, TechCrunch usw. automatisch in Audio-Podcasts umzuwandeln, so dass die Benutzer die Informationen im Web oder auf ihrem Handy anhören können, während sie pendeln, arbeiten oder beschäftigt sind. Das Projekt verwendet Next.js und Reagieren Sie Audibit unterstützt eine Null-Konfiguration für den Einstieg, wobei die Inhalte regelmäßig über GitHub Action aktualisiert und auf Netlify bereitgestellt werden. Benutzer können Artikel-Feeds anpassen, und die Community kann über GitHub Code beisteuern. Das Projekt ist unter der AGPL-3.0 für Technikbegeisterte und Entwickler lizenziert.
Funktionsliste
- Automatisches Crawlen von Tech-Artikeln von Hacker News, TechCrunch, InfoQ, CoinDesk und anderen.
- Verwandeln Sie Artikel mit Hilfe der Technologien OpenAI und Lemonfox in hochwertige Audio-Podcasts.
- Bereitstellung von Webanwendungen (
https://audibit.app
), unterstützt das sofortige Abhören. - Unterstützung für React Native Mobile Apps, kompatibel mit iOS und Android.
- Artikel und Audiodateien werden täglich über GitHub Action aktualisiert, ohne dass ein manueller Aufwand erforderlich ist.
- Stellen Sie mit Netlify bereit, um den Hosting-Prozess zu optimieren.
- Offener Quellcode, Unterstützung für benutzerdefinierte Artikel-Feeds und Funktionserweiterungen.
- Verwenden Sie Pinecone und Firestore, um Artikeldaten und Suchindizes zu verwalten.
Hilfe verwenden
Installation und Einsatz
Audibit ist ein GitHub-basiertes Open-Source-Projekt, für dessen Installation und Bereitstellung grundlegende Entwicklungskenntnisse erforderlich sind. Hier sind die detaillierten Schritte:
- Klon-Lager
Klonen Sie Ihr Audibit-Repository lokal mit Git:git clone https://github.com/YinTokey/Audibit.git cd Audibit
- Installation von Abhängigkeiten
Stellen Sie sicher, dass Node.js installiert ist und führen Sie den folgenden Befehl aus, um die Projektabhängigkeiten zu installieren:npm install
- Umgebungsvariablen konfigurieren
Erstellen Sie im Stammverzeichnis des Projekts die Datei.env
fügen Sie Folgendes hinzu:OPENAI_API_KEY=[your_openai_key] GOOGLE_SERVICE_ACCOUNT=[your_service_account_string] PINECONE_API_KEY=[your_pinecone_key] DB_NAME=Audibit
OPENAI_API_KEY
: von der offiziellen OpenAI-Website für Text-to-Speech.GOOGLE_SERVICE_ACCOUNT
für die Firestore-Datenbank, siehe Projektdokumentationgoogle_service.md
Erzeugen.PINECONE_API_KEY
Für die Pinecone-Indizierung müssen Sie den Namen der Firestore-Datenbank (Audibit
).- Stellen Sie sicher, dass der Firestore und Pinecone eine neue Datei namens
Audibit
Die Datenbank und der Index der
- lokaler Betrieb
Starten Sie den Entwicklungsserver und zeigen Sie das Projekt in der Vorschau an:npm run dev
Interviews
http://localhost:3000
Betrachten Sie die Webanwendung. - Aufbau und Produktionslauf
Erstellen Sie die Produktionsversion und starten Sie den Dienst:npm run build npm run start
- Zeitgesteuerte Aufgaben konfigurieren
Audibit verwendet GitHub Action, um Artikel automatisch zu crawlen. bearbeiten.github/workflows/cron_job.yml
stellen Sie die tägliche Aufnahmezeit ein, detaillierte Beschreibung siehecron_job.md
. - Bereitstellen auf Netlify
- Melden Sie sich bei Netlify an und erstellen Sie eine neue Website.
- Verbinden Sie sich mit Ihrem GitHub-Repository und wählen Sie das Audibit-Projekt aus.
- Setzen Sie den Build-Befehl auf
npm run build
Der Veröffentlichungskatalog lautet.next
. - Wenn die Bereitstellung abgeschlossen ist, lesen Sie die
deployment.md
Optimierte Konfiguration. - Einsatzorte sind verfügbar über die
https://audibit.app
Zugang.
- mobile Anwendung
Audibit bietet React Native Mobile Apps, Repository-Adresse:git clone https://github.com/YinTokey/audibit-mobile.git
- Installieren Sie die React Native-Umgebung und führen Sie
npm install
. - Starten Sie die Anwendung:
npx react-native run-android npx react-native run-ios
- Die App verbindet sich mit der von Netlify bereitgestellten API, um Audioinhalte abzurufen.
- Installieren Sie die React Native-Umgebung und führen Sie
Bedienung der Hauptfunktionen
Audio-Podcasts anhören
- Interviews
https://audibit.app
Oder öffnen Sie die mobile App. - Auf der Startseite finden Sie Audio-Listen mit den neuesten technischen Artikeln aus Quellen wie Hacker News, TechCrunch und anderen.
- Klicken Sie auf den Titel des Artikels, um die Audiodatei abzuspielen, und unterstützen Sie das Anhalten, Vorspulen, Zurückspulen und Herunterladen.
- Mobile unterstützt die Hintergrundwiedergabe für Pendler- oder Fitnessszenarien.
- Die Web-Seite verwendet Chakra UI, um eine saubere Schnittstelle und ein responsives Design zu bieten, das sich an verschiedene Geräte anpasst.
Benutzerdefinierter Artikel-Feed
- Compiler
config/feeds.js
Die erste besteht darin, neue RSS-Feeds hinzuzufügen, wie z. B.:feeds: [ { name: 'Hacker News', url: 'https://news.ycombinator.com/rss' }, { name: 'TechCrunch', url: 'https://techcrunch.com/feed/' }, { name: 'Custom Feed', url: '[your_rss_url]' } ]
- Nachdem Sie Ihre Änderungen übertragen haben, führen Sie GitHub Action aus, um die Audioinhalte zu aktualisieren.
Suche und Datenverwaltung
- Pinecone bietet eine Artikelsuchfunktion und mobile Unterstützung für die Stichwortsuche.
- Anzeige der Artikel-Metadaten in der Firestore-Konsole, die manuell gelöscht oder bearbeitet werden können.
- Überprüfen Sie die Datenbank regelmäßig, um die Datensynchronisation und die Integrität des Indexes sicherzustellen.
caveat
- Schützen Sie API-Schlüssel vor dem Durchsickern in öffentliche Repositories.
- Die kostenlosen Netlify-Pakete haben Traffic-Beschränkungen und müssen für eine hohe Nutzungsfrequenz aufgerüstet werden.
- Die mobile App sollte mit den neuesten iOS- und Android-Systemen kompatibel sein.
- Um Code beizutragen, ist ein Pull Request erforderlich, der den Richtlinien für Projektbeiträge entspricht.
- Das Projekt verwendet die AGPL-3.0-Lizenz, und Änderungen am Code müssen quelloffen sein.
Featured Function Bedienung
Null-Konfigurations-Schnellstart
- Die Benutzer benötigen keine komplexen Einstellungen für den Zugriff
https://audibit.app
Sie können es sich anhören. - GitHub Action aktualisiert seine Inhalte automatisch, sodass sich die Nutzer nur noch auf das Hörerlebnis konzentrieren müssen.
Hochwertige Audioerzeugung
- In Kombination mit OpenAI und Lemonfoxs TTS-Technologie ist der Ton klar und natürlich.
- Unterstützt die Konvertierung mehrsprachiger Artikel für internationalisierte Benutzer.
Community Driven Development
- Benutzer können über GitHub Feedback zu Problemen, Funktionsvorschlägen oder Codeverbesserungen einreichen.
- Fokus auf Entwickler
@yintokey
Ihres X-Kontos, um Projektaktualisierungen zu erhalten.
Anwendungsszenario
- Zugang zu Informationen während des Pendelns
Die Nutzer hören die neuesten TechCrunch-Artikel auf Audibit mobile, während sie im Bus oder in der U-Bahn sitzen, und können so ihre Zeit effizient nutzen. - Entwickler Technologie Lernen
Programmierer hören sich die aktuellen Diskussionen auf Hacker News an, um sich über Open-Source-Projekte oder Programmiertrends zu informieren, die die Entwicklung inspirieren. - Wissensinput während der Fitness
Die Benutzer hören die technischen Artikel von InfoQ über Kopfhörer, während sie laufen oder trainieren, so dass sie gleichzeitig trainieren und lernen können. - Engagement der Open-Source-Gemeinschaft
Entwickler lernen moderne Web-Entwicklungstechniken, indem sie das Next.js-Frontend von Audibit oder React Native-Anwendungen optimieren.
QA
- Welche Artikelquellen werden von Audibit unterstützt?
Hacker News, TechCrunch, InfoQ, CoinDesk werden standardmäßig unterstützt, mit benutzerdefinierten RSS-Feeds. - Wie kann ich mein Projekt lokal durchführen?
Klonen von Repositories, Installieren von Abhängigkeiten, Konfigurieren.env
Datei, führen Sie dienpm run dev
. - Muss ich für die Bereitstellung auf Netlify bezahlen?
Die kostenlosen Pakete von Netlify unterstützen individuelle Implementierungen, wobei Gebühren für das Überschreiten von Verkehrsgrenzen anfallen. - Wie ist die Audioqualität?
Durch die Verwendung von OpenAI und der TTS-Technologie von Lemonfox ist der Ton klar und unterstützt mehrere Sprachen. - Wie kann ich Code beisteuern?
Reichen Sie einen Pull Request auf GitHub ein, beachten Sie die Richtlinien für Beiträge und freuen Sie sich über Feedback zu Problemen und Funktionsvorschläge.