Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Elixir client #1833

Merged
merged 33 commits into from
Nov 6, 2024
Merged

Add Elixir client #1833

merged 33 commits into from
Nov 6, 2024

Conversation

magnetised
Copy link
Contributor

No description provided.

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit 4431d4f
🔍 Latest deploy log https://app.netlify.com/sites/electric-next/deploys/672b3cc574cffd0008cd85a2
😎 Deploy Preview https://deploy-preview-1833--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@thruflo
Copy link
Contributor

thruflo commented Oct 14, 2024

Hey, can I also request that this PR also updates https://github.com/electric-sql/electric/blob/main/website/docs/api/clients/elixir.md -- shout if you want to sync on what we should document there.

@magnetised magnetised force-pushed the magnetised/elixir-client branch 3 times, most recently from c23c3a4 to 03226a2 Compare October 15, 2024 09:37
@magnetised
Copy link
Contributor Author

@thruflo have done a quick re-write of the elixir client docs: 03226a2

Happy to evolve

@thruflo
Copy link
Contributor

thruflo commented Oct 15, 2024

@thruflo have done a quick re-write of the elixir client docs: 03226a2

Happy to evolve

Looks good. Is the idea to merge this separately of electric_phoenix and thus not mention that yet? If so, let's make sure to add info about the Phoenix streams integration when that's published too.

@magnetised
Copy link
Contributor Author

Looks good. Is the idea to merge this separately of electric_phoenix and thus not mention that yet? If so, let's make sure to add info about the Phoenix streams integration when that's published too.

yeah. we really need the client in hex to make the separate phoenix integration work.

@magnetised magnetised marked this pull request as ready for review October 16, 2024 10:33
@magnetised magnetised force-pushed the magnetised/elixir-client branch 2 times, most recently from a4b6e2d to c5fb512 Compare October 31, 2024 12:41
Copy link
Contributor

@thruflo thruflo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we merge this?

@magnetised magnetised force-pushed the magnetised/elixir-client branch from c5fb512 to 227b4b4 Compare November 5, 2024 12:30
Copy link
Contributor

@robacourt robacourt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

packages/elixir-client/README.md Show resolved Hide resolved
@magnetised magnetised force-pushed the magnetised/elixir-client branch 3 times, most recently from 139cfe1 to b683205 Compare November 5, 2024 16:33
thruflo added a commit that referenced this pull request Nov 5, 2024
Fleshing out deployment guide. To support it, added a sync service
config page in the api docs section and specific integrations pages for
various deployment platforms.

Quite a lot to review here. Check out the:

- [Sync service config page at
/docs/api/config](https://deploy-preview-1836--electric-next.netlify.app/docs/api/config)
- [Updated Typescript client page at
/docs/api/clients/typescript](https://deploy-preview-1836--electric-next.netlify.app/docs/api/clients/typescript)
- [Deployment page at
/docs/guides/deployment](https://deploy-preview-1836--electric-next.netlify.app/docs/guides/deployment)
- Individual integration pages in the "Integrations" section of the docs
nav, e.g.:
[AWS](https://deploy-preview-1836--electric-next.netlify.app/docs/integrations/aws),
[React](https://deploy-preview-1836--electric-next.netlify.app/docs/integrations/react)
and
[Supabase](https://deploy-preview-1836--electric-next.netlify.app/docs/integrations/supabase)

Note that:

- Netlify has a one-click-deploy form that uses
https://github.com/electric-sql/standalone-basic-example
-
[Render](https://deploy-preview-1836--electric-next.netlify.app/docs/integrations/supabase)
has a [Blueprint repo](https://github.com/electric-sql/render-blueprint)
that also uses the same standalone-basic-example

As @KyleAMathews commented on Discord, these might be better to include
in the monorepo and update using a GitHub action. Perhaps that can be a
subsequent Issues / PR.

The integrations also include a [Phoenix
page](https://deploy-preview-1836--electric-next.netlify.app/docs/integrations/phoenix)
which is based on merging #1833 and publishing an updated release for
https://hexdocs.pm/electric_phoenix/0.1.0-dev-2/Electric.Phoenix.html

Note that the deployment docs all assume a single `DATABASE_URL`, i.e.:
this is pre multi-tenant.

---------

Co-authored-by: Kyle Mathews <[email protected]>
@thruflo
Copy link
Contributor

thruflo commented Nov 5, 2024

@magnetised magnetised force-pushed the magnetised/elixir-client branch from 5a58d51 to 4431d4f Compare November 6, 2024 09:54
@magnetised magnetised merged commit a196399 into main Nov 6, 2024
25 checks passed
@magnetised magnetised deleted the magnetised/elixir-client branch November 6, 2024 10:56
@thruflo
Copy link
Contributor

thruflo commented Nov 6, 2024

Yey!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants