electric-sql/electric

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

クローズ

#1,878 opened on 2024/10/21

GitHub で見るコントリビューターガイド
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Elixir (329 件のフォーク)batch import
documentationfeature requestgood first issuehelp wanted

Repository metrics

Stars
 (10,155 個のスター)
PR merge metrics
 (平均マージ 3d 16h) (30d で 149 merged PRs)

説明

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.

コントリビューターガイド

調査方針
このタスクは、Electric SQL を他のサーバーサイド Web フレームワークと統合するためのドキュメントを追加するもので、既存の Phoenix 統合をテンプレートとして使用します。現在の Phoenix 統合ドキュメントは https://electric sql.com/docs/integrations/phoenix にあります。この issue では、Rails、Laravel、Django、Spring Boot が例として挙げられています。ドキュメントは、URL ベースの統合と、認証済み設定のためのルート提供をカバーする必要があります。フレームワークに LiveView のようなシステムがある場合、Phoenix.Streams 統合パターンも適用可能です。この issue はオープンでコメントや PR がないため、コントリビューターはまずメンテナーに範囲を明確にする必要があります。例えば、どのフレームワークが優先されるか、どのような具体的な形式が望まれるかを尋ねることが考えられます。
技術スタック
elixir
領域
documentationbackend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70