electric-sql/electric

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

Fechada

#1.878 aberto em 21 de out. de 2024

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Elixir (329 forks)batch import
documentationfeature requestgood first issuehelp wanted

Métricas do repositório

Stars
 (10.155 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d 16h) (149 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
A tarefa envolve adicionar documentação para integrar o Electric SQL com outros frameworks web do lado do servidor, seguindo a integração Phoenix existente como modelo. A documentação atual da integração Phoenix está em https://electric sql.com/docs/integrations/phoenix. A issue lista Rails, Laravel, Django e Spring Boot como exemplos. A documentação deve cobrir integração baseada em URL e servir uma rota para configuração autorizada. Se o framework tiver um sistema semelhante ao LiveView, o padrão de integração Phoenix.Streams também pode ser aplicável. Como a issue está aberta sem comentários ou PRs, um contribuidor deve primeiro esclarecer o escopo com os mantenedores, possivelmente perguntando quais frameworks são priorizados e qual formato específico é desejado.
Pilha de tecnologia
elixir
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Understanding of Electric SQL Phoenix integrationFamiliarity with server side web frameworks like Rails, Laravel, Django, Spring Boot
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70