electric-sql/electric

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

Closed

#1,878 opened on Oct 21, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Elixir (329 forks)batch import
documentationfeature requestgood first issuehelp wanted

Repository metrics

Stars
 (10,155 stars)
PR merge metrics
 (Avg merge 3d 16h) (149 merged PRs in 30d)

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.

Contributor guide

Research direction
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.
Tech stack
elixir
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70