electric-sql/electric

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

已關閉

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

在 GitHub 查看貢獻者指南
 (0 則留言) (0 個反應) (0 位負責人)Elixir (329 個分叉)batch import
documentationfeature requestgood first issuehelp wanted

倉庫指標

星標
 (10,155 顆星)
PR 合併指標
 (平均合併 3天 16小時) (30 天內合併 149 個 PR)

描述

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。該議題列出了 Rails、Laravel、Django 和 Spring Boot 作為範例。文件應涵蓋基於 URL 的整合以及為授權設定提供路由服務。如果框架具有類似 LiveView 的系統，Phoenix.Streams 整合模式也可能適用。由於該議題是開放的，沒有評論或 PR，貢獻者應首先與維護者明確範圍，例如詢問哪些框架是優先考慮的，以及期望的具體格式是什麼。
技術棧
elixir
領域
documentationbackend
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70