https://github.com/yugabytedb-samples/yugabytedb-simple-elixir-app

A simple Elixir app that connects to a YugabyteDB cluster and performs basic CRUD operations.
https://github.com/yugabytedb-samples/yugabytedb-simple-elixir-app

elixir elixir-lang elixir-phoenix yugabyte yugabytedb

Last synced: about 1 month ago
JSON representation

A simple Elixir app that connects to a YugabyteDB cluster and performs basic CRUD operations.

• Host: GitHub
• URL: https://github.com/yugabytedb-samples/yugabytedb-simple-elixir-app
• Owner: YugabyteDB-Samples
• License: apache-2.0
• Created: 2024-07-16T12:42:49.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-23T19:40:20.000Z (4 months ago)
• Last Synced: 2024-10-12T23:41:27.302Z (about 1 month ago)
• Topics: elixir, elixir-lang, elixir-phoenix, yugabyte, yugabytedb
• Language: Elixir
• Homepage:
• Size: 490 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Elixir Application for YugabyteDB

The code sample shows how to create a simple Elixir app that works with YugabyteDB using the [Postgrex driver](https://docs.yugabyte.com/latest/integrations/jdbc-driver/) or the [Phoenix framework](https://www.phoenixframework.org).

The instructions below are provided for [YugabyteDB Aeon](https://cloud.yugabyte.com/) deployments. However, the app also works with other types of deployments, including database instances running on [your own laptop](https://docs.yugabyte.com/preview/quick-start/docker/).

## Prerequisite

* [The latest versions](https://elixir-lang.org/docs.html) of the Elixir, Erlang VM, IEx and Mix.

* If you plan to run the Phoenix sample app, then install all the [required components](https://hexdocs.pm/phoenix/installation.html). Note, you don't need to install Postgres for Phoenix as long as you'll use YugabyteDB.

* Command line tool or your favourite IDE, such as IntelliJ IDEA, or Eclipse.

## Start YugabyteDB Aeon Cluster

* [Start](https://docs.yugabyte.com/latest/yugabyte-cloud/cloud-quickstart/qs-add/) a free instance of YugabyteDB Aeon.

* Add an IP address of your machine/laptop to the [IP allow list](https://docs.yugabyte.com/latest/yugabyte-cloud/cloud-secure-clusters/add-connections/#manage-ip-allow-lists)

![image](cloud-add-free-cluster.gif)

## Run the App

Clone the application repo:

```bash

git clone https://github.com/YugabyteDB-Samples/yugabytedb-simple-elixir-app.git && cd yugabytedb-simple-elixir-app

```

Start the app using the Postgrex driver or Phoenix framework:

* [Simple Elixir App With Postgrex](postgrex/simple_app/README.md)

* [Simple Elixir App with Phoenix](phoenix/simple_app/README.md)

## Stay in touch

Having issues running this application or want to learn more from the Yugabyte community?

Join [our Slack channel](https://communityinviter.com/apps/yugabyte-db/register)!