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.