Skip to main content
Version: Config V1 (legacy)

Getting Started

This page is an overview and a short guide on how to get started.

ConfigCat is a cloud-based service that lets you release features without code deployments.

You can use it with many similar techniques such as feature flags/toggles, canary releases, soft launches, A-B testing, remote configuration management, and phased rollouts. Configure your application and features even after deployment.

The birth of a Feature Flag​

First, add a feature flag on the ConfigCat Dashboard, then you can connect your application to the ConfigCat service to access your feature flag.

Create a feature flag on the ConfigCat Dashboard​

  1. Log in to the Dashboard
  2. Click ADD FEATURE FLAG and give it a name.
getting-started

Explore with Our Tutorial App​

Before diving into connecting your actual application, consider exploring our Feature Flags Tutorial. This interactive app provides a practical and engaging way to learn about ConfigCat and feature flags without needing to integrate immediately with your current projects. It’s perfect for beginners to understand the functionalities and advantages of using feature flags effectively.

Feature Flags Tutorial

Start the Feature Flags Tutorial

Connect your application​

There are ready to use code snippets for .NET, Java, Android (Java), Kotlin, iOS (Swift), Dart (Flutter), Node, JavaScript, React, Python, Go, PHP, Ruby, Elixir, C++ on the ConfigCat Dashboard, just scroll down to the SDK Key and steps to connect your application section.

All the ConfigCat SDKs are open-source and available on GitHub.

See the detailed Docs on how to use the ConfigCat SDKs.

Here's a short example to demonstrate the concept:

// 0. If necessary, install the ConfigCat SDK package for the platform you use.
// E.g. `npm install configcat-js`

// 1. Import the ConfigCat SDK package.
import * as configcat from 'configcat-js';

// 2. Get a client object for the SDK Key of your config.
const client = configcat.getClient('YOUR SDK KEY HERE');

// 3. Evaluate a feature flag using the client object.
const value = await client.getValueAsync('isMyFeatureEnabled', false);

// 4. Based on the value of the feature flag decide whether or not to enable the related feature.
if (value) {
  do_the_new_thing();
} else {
  do_the_old_thing();
}