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