Getting Started

Quickstart Guide

Get up and running with Feature Beam in under 10 minutes. Follow these simple steps to integrate feature flags into your application.

5 simple steps

Under 10 minutes

No credit card required

Create an Account

Install the SDK

Add the Feature Beam SDK to your project using your preferred package manager.

bash

npm install @featurebeam/sdk
# or
yarn add @featurebeam/sdk
# or
pnpm add @featurebeam/sdk

Initialize the Client

Create a Feature Beam client instance with your API key and environment configuration.

javascript

import { FeatureBeam } from '@featurebeam/sdk';

const fb = new FeatureBeam({
  apiKey: 'your-api-key',
  environment: 'production', // or 'development'
});

Check Feature Flags

Use the client to check if features are enabled for specific users or contexts.

javascript

// Check if a feature is enabled
const isEnabled = fb.isEnabled('new-checkout', {
  userId: 'user-123',
  email: 'user@example.com',
});

if (isEnabled) {
  // Show new checkout
  renderNewCheckout();
} else {
  // Show existing checkout
  renderLegacyCheckout();
}