Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/configcat/elixir-sdk

ConfigCat SDK for Elixir. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.
https://github.com/configcat/elixir-sdk

configcat elixir elixir-sdk feature-flags feature-management feature-toggles featureflags remote-config sdk

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/configcat/elixir-sdk
Owner: configcat
License: mit
Created: 2020-10-08T10:59:05.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-09-24T20:13:53.000Z (3 months ago)
Last Synced: 2024-09-30T09:02:22.238Z (2 months ago)
Topics: configcat, elixir, elixir-sdk, feature-flags, feature-management, feature-toggles, featureflags, remote-config, sdk
Language: Elixir
Homepage: https://configcat.com/docs/sdk-reference/elixir
Size: 574 KB
Stars: 20
Watchers: 6
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

fucking-awesome-elixir - ConfigCat - Elixir SDK for ConfigCat hosted feature flag service. (Feature Flags and Toggles)
awesome-elixir - ConfigCat - Elixir SDK for ConfigCat hosted feature flag service. (Feature Flags and Toggles)

README

        # ConfigCat SDK for Elixir

https://configcat.com

ConfigCat SDK for Elixir provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using [ConfigCat Dashboard](http://app.configcat.com) even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a [hosted feature flag service](http://configcat.com). Manage feature toggles across frontend, backend, mobile, desktop apps. [Alternative to LaunchDarkly](http://configcat.com). Management app + feature flag SDKs.

[![Elixir CI](https://github.com/configcat/elixir-sdk/actions/workflows/elixir-ci.yml/badge.svg?branch=main)](https://github.com/configcat/elixir-sdk/actions/workflows/elixir-ci.yml)

[![Coverage Status](https://codecov.io/github/configcat/elixir-sdk/badge.svg?branch=main)](https://codecov.io/github/configcat/elixir-sdk?branch=main)

[![Hex.pm](https://img.shields.io/hexpm/v/configcat.svg?style=circle)](https://hex.pm/packages/configcat)

[![HexDocs.pm](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/configcat/)

[![Hex.pm](https://img.shields.io/hexpm/dt/configcat.svg?style=circle)](https://hex.pm/packages/configcat)

[![Hex.pm](https://img.shields.io/hexpm/l/configcat.svg)](https://hex.pm/packages/configcat)

[![Last Updated](https://img.shields.io/github/last-commit/configcat/elixir-sdk.svg)](https://github.com/configcat/elixir-sdk/commits/main)

# Getting Started

### 1. Add `configcat` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:configcat, "~> 4.0.2"}

  ]

end

```

### 2. Go to the ConfigCat Dashboard to get your *SDK Key*:

![SDK-KEY](https://raw.githubusercontent.com/ConfigCat/elixir-sdk/main/assets/readme02-3.png  "SDK-KEY")

### 3. Add `ConfigCat` to your application Supervisor tree:

```elixir

def start(_type, _args) do

  children = [

    {ConfigCat, [sdk_key: "YOUR SDK KEY"]},

    MyApp

  ]

  opts = [strategy: :one_for_one, name: MyApp.Supervisor]

  Supervisor.start_link(children, opts)

end

```

### 4. Get your setting value:

```elixir

isMyAwesomeFeatureEnabled = ConfigCat.get_value("isMyAwesomeFeatureEnabled", false)

if isMyAwesomeFeatureEnabled do

  do_the_new_thing()

else

  do_the_old_thing()

end

```

## Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a `ConfigCat.User` object to the `ConfigCat.get_value/3` function.

Read more about [Targeting here](https://configcat.com/docs/advanced/targeting/).

```elixir

user = ConfigCat.User.new("#USER-IDENTIFIER#")

isMyAwesomeFeatureEnabled = ConfigCat.get_value("isMyAwesomeFeatureEnabled", false, user)

if isMyAwesomeFeatureEnabled do

    do_the_new_thing()

else

    do_the_old_thing()

end

```

## Sample/Demo apps

- [Sample Console Apps](https://github.com/configcat/elixir-sdk/tree/main/samples)

## Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at [ConfigCat Docs](https://configcat.com/docs/sdk-reference/elixir/).

## Need help?

https://configcat.com/support

## Contributing

Contributions are welcome. For more info please read the [Contribution Guideline](CONTRIBUTING.md).

## About ConfigCat

- [Official ConfigCat SDKs for other platforms](https://github.com/configcat)

- [Documentation](https://configcat.com/docs)

- [Blog](https://configcat.com/blog)