electric-sql/electric

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

Fermée

#1 878 ouverte le 21 oct. 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Elixir (329 forks)batch import
documentationfeature requestgood first issuehelp wanted

Métriques du dépôt

Stars
 (10 155 étoiles)
Métriques de merge PR
 (Merge moyen 3j 16h) (149 PRs mergées en 30 j)

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

Direction de recherche
La tâche consiste à ajouter une documentation pour intégrer Electric SQL avec d'autres frameworks web côté serveur, en suivant l'intégration Phoenix existante comme modèle. La documentation actuelle de l'intégration Phoenix se trouve à l'adresse https://electric sql.com/docs/integrations/phoenix. L'issue liste Rails, Laravel, Django et Spring Boot comme exemples. La documentation doit couvrir l'intégration basée sur les URL et la fourniture d'une route pour la configuration autorisée. Si le framework dispose d'un système de type LiveView, le modèle d'intégration Phoenix.Streams peut également être applicable. Comme l'issue est ouverte sans commentaires ni PR, un contributeur doit d'abord clarifier le périmètre avec les mainteneurs, par exemple en demandant quels frameworks sont prioritaires et quel format spécifique est souhaité.
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 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
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