electric-sql/electric

Documentation and framework integrations for other server-side web frameworks.

Geschlossen

#1.878 geöffnet am 21.10.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Elixir (329 Forks)batch import
documentationfeature requestgood first issuehelp wanted

Repository-Metriken

Stars
 (10.155 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 16h) (149 gemergte PRs in 30 T)

Beschreibung

The patterns from the Phoenix integration are very applicable to other server-side / full-stack frameworks. Particularly integrating Electric via URL and serving a route that then returns authorised config to the Electric client.

Popular frameworks would include:

  • Rails
  • Laravel
  • Django
  • Spring Boot
  • ... etc. ...

If the framework also has a LiveView style system then the Phoenix.Streams integration may be portable / applicable too.

Contributor Guide

Research-Richtung
Die Aufgabe umfasst das Hinzufügen von Dokumentation zur Integration von Electric SQL mit anderen serverseitigen Web Frameworks, wobei die bestehende Phoenix Integration als Vorlage dient. Die aktuelle Phoenix Integrationsdokumentation befindet sich unter https://electric sql.com/docs/integrations/phoenix. Das Issue listet Rails, Laravel, Django und Spring Boot als Beispiele auf. Die Dokumentation sollte URL basierte Integration und das Bereitstellen einer Route für autorisierte Konfiguration abdecken. Wenn das Framework ein LiveView ähnliches System hat, könnte auch das Phoenix.Streams Integrationsmuster anwendbar sein. Da das Issue offen ist, ohne Kommentare oder PRs, sollte ein Mitwirkender zunächst den Umfang mit den Maintainern klären, möglicherweise indem er fragt, welche Frameworks priorisiert werden und welches spezifische Format gewünscht ist.
Tech Stack
elixir
Domain
documentationbackend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70