electric-sql/electric

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

Open

#1,878 建立於 2024年10月21日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Elixir (10,155 star) (329 fork)batch import
documentationfeature requestgood first issuehelp wanted

描述

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.

貢獻者指南

技術棧
elixir
領域
documentationbackend
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.