electric-sql/electric

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

Open

#1 878 ouverte le 21 oct. 2024

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Elixir (10 155 stars) (329 forks)batch import
documentationfeature requestgood first issuehelp wanted

Description

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.

Guide contributeur

Stack technique
elixir
Domaine
documentationbackend
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
The task involves adding documentation for integrating Electric SQL with other server side web frameworks, following the existing Phoenix integration as a template. The current Phoenix integration documentation is at https://electric sql.com/docs/integrations/phoenix. The issue lists Rails, Laravel, Django, and Spring Boot as examples. The documentation should cover URL based integration and serving a route for authorized config. If the framework has a LiveView like system, the Phoenix.Streams integration pattern may also be applicable. Since the issue is open with no comments or PRs, a contributor should first clarify the scope with maintainers, possibly by asking which frameworks are prioritized and what specific format is desired.