electric-sql/electric

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

Open

#1,878 opened on 2024年10月21日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Elixir (10,155 stars) (329 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.