Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

ConfigCat SDK for Go. 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/go-sdk

configcat configuration configuration-management feature-flag feature-flags feature-toggle feature-toggles featureflags go golang remote-config

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/configcat/go-sdk
Owner: configcat
License: mit
Created: 2018-10-13T21:16:32.000Z (over 6 years ago)
Default Branch: v9
Last Pushed: 2024-08-08T09:27:21.000Z (6 months ago)
Last Synced: 2024-10-08T09:08:36.795Z (4 months ago)
Topics: configcat, configuration, configuration-management, feature-flag, feature-flags, feature-toggle, feature-toggles, featureflags, go, golang, remote-config
Language: Go
Homepage: https://configcat.com/docs/sdk-reference/go
Size: 649 KB
Stars: 21
Watchers: 5
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # ConfigCat SDK for Go

https://configcat.com

ConfigCat SDK for Go 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 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. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

[![Build Status](https://github.com/configcat/go-sdk/actions/workflows/go-ci.yml/badge.svg?branch=v9)](https://github.com/configcat/go-sdk/actions/workflows/go-ci.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/configcat/go-sdk/v9)](https://goreportcard.com/report/github.com/configcat/go-sdk/v9)

[![GoDoc](https://godoc.org/github.com/configcat/go-sdk?status.svg)](https://pkg.go.dev/github.com/configcat/go-sdk/v9)

[![Sonar Coverage](https://img.shields.io/sonar/coverage/configcat_go-sdk?logo=SonarCloud&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/project/overview?id=configcat_go-sdk)

[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/configcat_go-sdk?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/project/overview?id=configcat_go-sdk)

## Getting started

### 1. Install the package with `go`

```bash

go get github.com/configcat/go-sdk/v9

```

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

![SDK-KEY](https://raw.githubusercontent.com/ConfigCat/go-sdk/master/media/readme02-3.png  "SDK-KEY")

### 3. Import the *ConfigCat* client package to your application

```go

import "github.com/configcat/go-sdk/v9"

```

### 4. Create a *ConfigCat* client instance:

```go

client := configcat.NewClient("#YOUR-SDK-KEY#")

```

### 5. Get your setting value:

```go

isMyAwesomeFeatureEnabled := client.GetBoolValue("isMyAwesomeFeatureEnabled", false, nil)

if isMyAwesomeFeatureEnabled {

    DoTheNewThing()

} else {

    DoTheOldThing()

}

```

### 6. Close *ConfigCat* client on application exit:

```go

client.Close()

```

## 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 `UserData` struct to the specific setting evaluation method (`GetBoolValue()`, `GetStringValue()`, `GetIntValue()`, `GetFloatValue()`).

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

```go

user := &configcat.UserData{Identifier: "#USER-IDENTIFIER#"}

isMyAwesomeFeatureEnabled := client.GetBoolValue("isMyAwesomeFeatureEnabled", false, user)

if isMyAwesomeFeatureEnabled {

    DoTheNewThing()

} else {

    DoTheOldThing()

}

```

## 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/go/).

## 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)