eyeloupe

Projekt nicht mehr unter aktiver Entwicklung - Suche nach neuen Mitwirkenden

Eyeloupe

Der elegante Schienen -Debug -Assistent. KI angetrieben.
Melden Sie Fehler an · Anfrage -Feature

Eyeloupe ist der elegante Debug -Assistent der Rails. Es hilft Ihnen, Ihre Rails -Anwendung zu debuggen, indem Sie eine einfache und elegante Schnittstelle zur Verfügung stellen, um Ihre eingehenden/ausgehenden Anfragen und Ausnahmen anzuzeigen, die von KI betrieben werden.

Installation

Fügen Sie diese Zeile der GemFile Ihrer Anwendung hinzu:

 gem "eyeloupe"

Und dann ausführen:

$ bundle

Installieren Sie die Migrationen von Eyeloupe in Ihr Projekt:

$ rails eyeloupe:install:migrations

Und die Migrationen ausführen:

$ rails db:migrate

Um auf das Dashboard von Eyeloupe zuzugreifen, müssen Sie die folgende Route zu Ihrer Datei config/routes.rb hinzufügen:

 mount Eyeloupe :: Engine => "/eyeloupe" 

Konfiguration

Dies ist ein Beispiel für die Konfiguration, die Sie zu Ihrer initializers/eyeloupe.rb -Datei hinzufügen können:

 Eyeloupe . configure do | config |
  config . excluded_paths = %w[ assets favicon.ico service-worker.js manifest.json ]
  config . capture = Rails . env . development?
  config . openai_access_key = "your-openai-access-key"
  config . openai_model = "gpt-4"
  config . database = 'eyeloupe'
end

• excluded_paths ist eine Reihe von Pfaden, die Sie von der Eyeloupe Capture ausschließen möchten. Die Eyeloupe fügt diese ausgeschlossenen Pfade den Standards hinzu: %w[mini-profiler eyeloupe active_storage]
• capture ist ein Boolescher, um die Eyeloupe -Erfassung zu aktivieren/zu deaktivieren. Standardmäßig ist es auf true festgelegt.
• openai_access_key ist die Zugriffstaste für die OpenAI -API. Sie können hier einen bekommen.
• openai_model ist das Modell für die OpenAI -API. Hier finden Sie die Liste der verfügbaren Modelle.
• database ist eine optionale Datenbankkonfigurations -Eyeloupe (Datenbank).

Datenbank

Standardmäßig verwendet Eyeloupe dieselbe Datenbank wie Ihre Anwendung. Wenn Sie eine andere Datenbank verwenden möchten, um Ihre Produktionsumgebung sauber zu halten, können Sie eine neue Datenbankkonfiguration in Ihre Datei config/database.yml hinzufügen:

 development :
  primary :
    << : *default
    database : db/development.sqlite3
  eyeloupe :
    << : *default
    database : db/eyeloupe.sqlite3
    migrations_paths : <%= Gem.loaded_specs['eyeloupe'].full_gem_path + '/db/migrate' %>
    schema_dump : false

Mit dieser Weise können Sie die eyeloupe:install:migrations , vergessen Sie jedoch nicht, rails db:migrate RAILS_ENV=eyeloupe zum Einrichten der Datenbank zu migrieren.

Ausnahmebehandlung

Um Ausnahmen zu handhaben, sollten Sie die Standardschienenausnahmebedingung in Ihrer Umgebungskonfigurationsdatei (z. B. config/environments/development.rb ) deaktivieren:

 config . consider_all_requests_local = false 

Verwendung

Die Eyeloupe wurde ausschließlich für das Rails -Framework entwickelt.

Sie können es in Ihrer Entwicklungsumgebung verwenden, um Ihre Anwendung zu debuggen, aber es wird nicht empfohlen, sie in der Produktion zu verwenden.

Auto-Refresh

Durch die Aktivierung von Auto-Fresh wird die Seite alle 3 Sekunden aktualisiert, um Ihnen die neuesten Daten anzuzeigen.

Alle Daten löschen

Sie können alle von Eyeloupe gespeicherten Daten löschen, indem Sie auf die Schaltfläche Müll klicken.

AI -Assistent

Wenn Sie in der Konfiguration einen OpenAI -Zugriffsschlüssel definieren, können Sie auf der Seite "Ausnahmetails" einen neuen Abschnitt sehen. Dieser Abschnitt wird von der OpenAI -API angetrieben und kann Ihnen eine Lösung zur Lösung Ihrer Ausnahme geben. Es sendet den gesamten Inhalt der Datei mit der Ausnahme, um die beste Antwort auf Ihr Problem zu haben.

Upgrade

Wenn Ihr Upgrade -Eyeloupe auf die neueste Version aufgenommen wird, führen Sie die folgenden Befehle aus:

$ rails eyeloupe:install:migrations
$ rails db:migrate

Q/a

Warum ist die Anfragezeit nicht gleich auf dem Rack-Mini-Profiler?

Eyeloupe ist kein leistungsorientiertes Werkzeug, die Anforderungszeit ist dieselbe, die Sie im Rails-Protokoll anzeigen können. Wenn Sie weitere Details zu Ihrer Ladezeit wünschen, können Sie zusammen mit einer Eyeloupe Rack-Mini-Pro-Pro-Produkter verwenden.

Ist das das Laravel -Teleskop für Schienen?

Ja, die Eyeloupe ist vom Laravel -Teleskop inspiriert. Viele Leute, die aus Laravel kommen, fehlen ein Teleskop oder suchen nach etwas Ähnlichem. Daher ist die Eyeloupe hier, um diese Lücke zu schließen.

Beitragen

Beiträge machen die Open-Source-Community zu einem erstaunlichen Ort, um zu lernen, zu inspirieren und zu kreieren. Alle Beiträge, die Sie leisten, werden sehr geschätzt .

Wenn Sie einen Vorschlag haben, der dies besser machen würde, geben Sie bitte das Repo und erstellen Sie eine Pull -Anfrage. Sie können auch einfach ein Problem mit dem Tag "Verbesserung" eröffnen. Vergessen Sie nicht, dem Projekt einen Stern zu geben! Danke noch einmal!

1. Geben Sie das Projekt auf
2. Erstellen Sie Ihre Funktionszweig ( git checkout -b feature/amazing_feature ).
3. Bestimmen Sie Ihre Änderungen ( git commit -m 'Add some amazing feature' )
4. Push in den Zweig ( git push origin feature/amazing_feature )
5. Öffnen Sie eine Pull -Anfrage

Lizenz

Das Edelstein ist unter den Bedingungen der MIT -Lizenz als Open Source erhältlich.

Kontakt

Projektlink: https://github.com/alxlion/eyeloupe