{"id":13563055,"url":"https://github.com/configcat/elixir-sdk","last_synced_at":"2025-07-25T06:37:46.940Z","repository":{"id":37027318,"uuid":"302311821","full_name":"configcat/elixir-sdk","owner":"configcat","description":"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.","archived":false,"fork":false,"pushed_at":"2025-03-04T12:05:18.000Z","size":572,"stargazers_count":20,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-31T12:06:51.455Z","etag":null,"topics":["configcat","elixir","elixir-sdk","feature-flags","feature-management","feature-toggles","featureflags","remote-config","sdk"],"latest_commit_sha":null,"homepage":"https://configcat.com/docs/sdk-reference/elixir","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/configcat.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-08T10:59:05.000Z","updated_at":"2025-03-04T12:05:20.000Z","dependencies_parsed_at":"2023-12-13T12:39:18.869Z","dependency_job_id":"f177afb1-4c38-41a5-851f-71eb131561ee","html_url":"https://github.com/configcat/elixir-sdk","commit_stats":{"total_commits":194,"total_committers":8,"mean_commits":24.25,"dds":0.5154639175257731,"last_synced_commit":"d7f0d54c50484d24bf8a8d4040ab9fb55ef966f5"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/configcat%2Felixir-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/configcat%2Felixir-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/configcat%2Felixir-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/configcat%2Felixir-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/configcat","download_url":"https://codeload.github.com/configcat/elixir-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657282,"owners_count":20974345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["configcat","elixir","elixir-sdk","feature-flags","feature-management","feature-toggles","featureflags","remote-config","sdk"],"created_at":"2024-08-01T13:01:14.682Z","updated_at":"2025-07-25T06:37:46.923Z","avatar_url":"https://github.com/configcat.png","language":"Elixir","funding_links":[],"categories":["Feature Flags and Toggles"],"sub_categories":[],"readme":"# ConfigCat SDK for Elixir\r\n\r\nhttps://configcat.com\r\n\r\nConfigCat SDK for Elixir provides easy integration for your application to ConfigCat.\r\n\r\nConfigCat 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.\r\n\r\nConfigCat 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.\r\n\r\n[![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)\r\n[![Coverage Status](https://codecov.io/github/configcat/elixir-sdk/badge.svg?branch=main)](https://codecov.io/github/configcat/elixir-sdk?branch=main)\r\n[![Hex.pm](https://img.shields.io/hexpm/v/configcat.svg?style=circle)](https://hex.pm/packages/configcat)\r\n[![HexDocs.pm](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/configcat/)\r\n[![Hex.pm](https://img.shields.io/hexpm/dt/configcat.svg?style=circle)](https://hex.pm/packages/configcat)\r\n[![Hex.pm](https://img.shields.io/hexpm/l/configcat.svg)](https://hex.pm/packages/configcat)\r\n[![Last Updated](https://img.shields.io/github/last-commit/configcat/elixir-sdk.svg)](https://github.com/configcat/elixir-sdk/commits/main)\r\n\r\n\r\n# Getting Started\r\n\r\n### 1. Add `configcat` to your list of dependencies in `mix.exs`:\r\n\r\n```elixir\r\ndef deps do\r\n  [\r\n    {:configcat, \"~\u003e 4.0.3\"}\r\n  ]\r\nend\r\n```\r\n\r\n### 2. Go to the \u003ca href=\"https://app.configcat.com/sdkkey\" target=\"_blank\"\u003eConfigCat Dashboard\u003c/a\u003e to get your *SDK Key*:\r\n![SDK-KEY](https://raw.githubusercontent.com/ConfigCat/elixir-sdk/main/assets/readme02-3.png  \"SDK-KEY\")\r\n\r\n### 3. Add `ConfigCat` to your application Supervisor tree:\r\n\r\n```elixir\r\ndef start(_type, _args) do\r\n  children = [\r\n    {ConfigCat, [sdk_key: \"YOUR SDK KEY\"]},\r\n    MyApp\r\n  ]\r\n\r\n  opts = [strategy: :one_for_one, name: MyApp.Supervisor]\r\n  Supervisor.start_link(children, opts)\r\nend\r\n```\r\n\r\n### 4. Get your setting value:\r\n\r\n```elixir\r\nisMyAwesomeFeatureEnabled = ConfigCat.get_value(\"isMyAwesomeFeatureEnabled\", false)\r\nif isMyAwesomeFeatureEnabled do\r\n  do_the_new_thing()\r\nelse\r\n  do_the_old_thing()\r\nend\r\n```\r\n\r\n## Getting user specific setting values with Targeting\r\n\r\nUsing 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.\r\n\r\nRead more about [Targeting here](https://configcat.com/docs/advanced/targeting/).\r\n\r\n```elixir\r\nuser = ConfigCat.User.new(\"#USER-IDENTIFIER#\")\r\n\r\nisMyAwesomeFeatureEnabled = ConfigCat.get_value(\"isMyAwesomeFeatureEnabled\", false, user)\r\nif isMyAwesomeFeatureEnabled do\r\n    do_the_new_thing()\r\nelse\r\n    do_the_old_thing()\r\nend\r\n```\r\n\r\n## Sample/Demo apps\r\n\r\n- [Sample Console Apps](https://github.com/configcat/elixir-sdk/tree/main/samples)\r\n\r\n## Polling Modes\r\n\r\nThe 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/).\r\n\r\n## Need help?\r\n\r\nhttps://configcat.com/support\r\n\r\n## Contributing\r\n\r\nContributions are welcome. For more info please read the [Contribution Guideline](CONTRIBUTING.md).\r\n\r\n## About ConfigCat\r\n\r\n- [Official ConfigCat SDKs for other platforms](https://github.com/configcat)\r\n- [Documentation](https://configcat.com/docs)\r\n- [Blog](https://configcat.com/blog)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconfigcat%2Felixir-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconfigcat%2Felixir-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconfigcat%2Felixir-sdk/lists"}