Flags SDK Template

This example uses a template adapter for feature flags with the Flags SDK that works with the Flags Explorer.

Demo

https://flags-sdk-hypertune.vercel.app/

How it works

This demo shows different combinations of two banners on the home page. The banners are configured to show/hide each banner 50% of the time.

Once you visit the page, you can see a variation of both/one/none of the banners. Since this example is using a stable id to identify users, you will see the same variation until you reset your id.

To test different variations, you can use the Dev Tools at the bottom to reset the stable id and reload the page. This allows you to test different variations of the banners.

If you clone the example, you can also use the Flags Explorer to test different variations by creating overrides.

Deploy this template

Step 1: Link the project

In order to use the Flags Explorer, you need to link the project on your local machine.

1
vercel link

Select the project from the list you just deployed.

Step 2: Pull all environment variables

This allows the Flags SDK and the Flags Explorer to work correctly, by getting additional metadata.

1
vercel env pull

Step 3: Set up Hypertune

In the Hypertune dashboard, try this example by pasting the following schema into the Schema tab:

1
"""
2
This `Context` input type is used for the `context` argument on your root field.
3
It contains details of the current `user` and `environment`.
4

5
You can define other custom input types with fields that are primitives, enums
6
or other input types.
7
"""
8
input Context {
9
  stableId: String!
10
  environment: Environment!
11
}
12

13
type Root {
14
  delay: Int!
15
  proceedToCheckout: ProceedToCheckout!
16
  freeDelivery: Boolean!
17
  summerSale: Boolean!
18
}
19

20
enum Environment {
21
  development
22
  production
23
  test
24
}
25

26
enum ProceedToCheckout {
27
  blue
28
  red
29
  green
30
}

You will also need to create the logic for the flags to enable the flags to return different variants.

Create a Flag for the delay flag, and set the Type to Number.

Create a Test for each flag that splits traffic between users, and select the appropriate type for each flag.

Flags should be called delay, proceedToCheckout, freeDelivery, and summerSale as seen in flags.ts