Allgemeine Einführung
Austen ist ein quelloffenes KI-Tool, das das Angular-Framework und die Analogjs-Initialisierung in Kombination mit der Mermaidjs-Technologie nutzt, um Diagramme zu erstellen, die den Nutzern bei der Analyse von Charakterbeziehungen in Büchern helfen. Benutzer können den Namen des Buches in der Open Library eingeben, Austen generiert automatisch ein visuelles Diagramm der Charakterbeziehungen durch KI und unterstützt das Speichern, Teilen und Herunterladen. Das Tool eignet sich für Literaturenthusiasten, Studenten oder Entwickler. Das Projekt ist völlig kostenlos und wird auf GitHub gehostet, so dass sich jeder an der Verbesserung des Tools beteiligen kann.
Funktionsliste
- Suche und Analyse von BüchernUnterstützt die Suche in jedem Buch von Open Library und die Durchführung von Charakteranalysen.
- KI-gesteuerte Extraktion von CharakterbeziehungenKI-Technologie zur automatischen Erkennung von Personen und deren Beziehungen in Büchern.
- Mermaidjs-Diagramm generierenÜbersetzung von Analysen in intuitive Beziehungsdiagramme.
- Diagramme speichern und herunterladenDie erzeugten Diagramme können in einer Datenbank gespeichert und im SVG- oder PNG-Format heruntergeladen werden.
- Öffentliche oder private FreigabeBenutzer haben die Möglichkeit, das Diagramm öffentlich zu machen, damit andere es sehen können, oder es privat zu halten.
- Durchsuchen Sie die Charts anderer PersonenDiagramme anzeigen, die von anderen Benutzern auf der Seite Entdecken veröffentlicht wurden.
- Likes-Funktion (in Entwicklung)Künftig wird es möglich sein, eine Lieblingskarte zu mögen oder nicht zu mögen.
Hilfe verwenden
Austen erfordert eine lokale Installation und es gibt derzeit keine Online-Version. Nachfolgend finden Sie eine ausführliche Installations- und Nutzungsanleitung, die Ihnen den Einstieg erleichtert.
Einbauverfahren
- Projektcode herunterladen
Klonen Sie das Projekt lokal, indem Sie den folgenden Befehl in das Terminal eingeben:
git clone https://github.com/herol3oy/austen.git
Wechseln Sie dann in das Projektverzeichnis:
cd austen
- Installation von Paketen mit Abhängigkeiten
Verwenden Sie npm, um die erforderlichen Pakete zu installieren:
npm install
- Umgebungsvariablen konfigurieren
Kopieren Sie die Beispieldatei und benennen Sie sie um.env
::
cp .env.example .env
zeigen (eine Eintrittskarte) .env
Datei, geben Sie die folgenden Informationen ein:
DEEPSEEK_API_KEY
: Von DeepSeek Der API-Schlüssel, den Sie bei der Registrierung auf der offiziellen Website erhalten.VITE_PUBLIC_SUPABASE_URL
URL des Supabase-Projekts.VITE_PUBLIC_SUPABASE_ANON_KEY
: Der anonyme Schlüssel der Supabase.
Falls gewünscht, kann auch der OpenAI-Schlüssel konfiguriert werden (optional).
- Einrichten der Supabase-Datenbank
- Besuchen Sie https://supabase.com, um ein neues Projekt zu erstellen.
- Aktivieren Sie die Authentifizierung (Authentication).
- Erstellt im öffentlichen Schema
graphs
Tabelle mit den folgenden Feldern:id
(uuid, Primärschlüssel)book_name
(Text, nicht-leer)author_name
(Text, nicht-leer)svg_graph
(Text, nicht-leer)mermaid_syntax
(Text, nicht-leer)emojis
(Text, optional)user_id
(uuid)is_public
(boolescher Wert, Standardwert false)created_at
(Zeitstempel)
Nach dem Speichern geben Sie die Projekt-URL und den anonymen Schlüssel in das Feld.env
.
- Starten des lokalen Servers
Geben Sie den folgenden Befehl ein, um das Projekt auszuführen:
npm run dev
Öffnen Sie Ihren Browser und besuchen Sie http://localhost:5173
(Anschlüsse können je nach Konfiguration variieren).
- Bereitstellung in der Produktionsumgebung
Wenn Sie die Software auf einem Server bereitstellen möchten, führen Sie sie aus:
npm run build
Einmal erstellt, kann sie auf Plattformen wie Cloudflare Pages hochgeladen werden.
Verwendung der wichtigsten Funktionen
- Erstellen von Rollenbeziehungsdiagrammen
Nach dem Start geben Sie auf der ersten Seite den Buchtitel und den Autor ein (z. B. "The Wizard of Oz" von L. Frank Baum). Klicken Sie auf "Generieren" und die KI analysiert den Inhalt des Buches und zeigt nach einigen Sekunden ein Mermaidjs-Diagramm an. Das Diagramm zeigt die Beziehungen zwischen den Charakteren, wie z. B. die "Haustier"-Beziehung von Dorothy und Toto. - Diagramme speichern und herunterladen
Nachdem Sie das Diagramm erstellt haben, klicken Sie auf die Schaltfläche "Speichern" und die Daten werden in der Supabase gespeichert. Sie können das Diagramm im SVG- oder PNG-Format herunterladen, um es weiterzugeben oder auszudrucken. - Aktienchart
Suchen Sie auf der Seite Meine Diagramme das von Ihnen erstellte Diagramm. Wählen Sie die Option "Öffentlich", damit andere Benutzer es auf der Seite "Entdecken" sehen können. Wenn Sie es nicht freigeben möchten, lassen Sie es einfach privat. - Durchsuchen Sie die Charts anderer Personen
Auf der Seite "Entdecken" können Sie Diagramme einsehen, die von anderen Benutzern veröffentlicht wurden. Zum Beispiel hat jemand ein Beziehungsdiagramm für Stolz und Vorurteil geteilt, das Sie direkt ansehen können. - Likes-Funktion (noch zu implementieren)
Die aktuelle Version verfügt noch nicht über einen Like-Button. Die Entwickler planen, "Gefällt mir"- und "Gefällt mir nicht"-Funktionen hinzuzufügen, mit denen Sie für Ihre Lieblingscharts stimmen können.
Beispiel für den Betriebsablauf
Willst du The Wizard of Oz analysieren? Versuchen Sie es mit dieser Schritt-für-Schritt-Anleitung:
- Geben Sie auf der ersten Seite den Titel "Der Zauberer von Oz" und den Autor "L. Frank Baum" ein.
- Klicken Sie auf "Generieren" und warten Sie ein paar Sekunden.
- Sehen Sie sich die Charts an: Dorothy ist das Herzstück, mit Verbindungen zu Toto, Scarecrow und anderen.
- Klicken Sie auf "Speichern" und wählen Sie "Öffentlich".
- Gehen Sie auf die Seite Meine Diagramme, um die SVG-Datei herunterzuladen, oder schauen Sie auf der Seite Entdecken nach, ob Sie Feedback von anderen erhalten.
Technische Einzelheiten
- Die Schnittstelle basiert auf Angular Material, das schön und einfach zu bedienen ist.
- Die Diagramme werden von Mermaidjs gezeichnet und unterstützen benutzerdefinierte Themenfarben.
- Die KI-Analyse stützt sich auf DeepSeek oder OpenAI, um genaue Ergebnisse zu gewährleisten.
Anwendungsszenario
- Literarische Studien
Austen-Fans können das Netzwerk der Charaktere in Jane Eyre analysieren und die Beziehung zwischen Jane und Rochester visualisieren. - Unterricht im Klassenzimmer
Die Lehrkraft erstellt ein Harry-Potter-Diagramm, das den Schülern helfen soll, die Freundschaft von Harry, Ron und Hermine zu verstehen. - Technisches Lernen
Entwickler können den Code studieren und lernen, wie sie ähnliche Tools mit Angular und Supabase erstellen können.
QA
- Welche Bücher werden unterstützt?
Jedes Buch, für das Open Library Daten hat, ist geeignet, z. B. Stolz und Vorurteil oder Der Zauberer von Oz. - Können Diagramme bearbeitet werden?
Die aktuelle Version unterstützt keine direkte Bearbeitung, aber Sie können den Mermaidjs-Code ändern und neu generieren. - Muss ich bezahlen?
Nicht nötig, das Projekt ist völlig kostenlos. Aber die Ausführung erfordert die Konfiguration des API-Schlüssels und der Supabase selbst. - Warum Supabase verwenden?
Sie ist für die Speicherung von Kartendaten, die Unterstützung der öffentlichen Freigabe und die Benutzerverwaltung zuständig.