Skip to content

featurevisor/featurevisor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

606 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Featurevisor

Feature management for developers

Manage your feature flags and experiments declaratively from the comfort of your Git workflow.


What is Featurevisor?

Featurevisor is a solution for managing your feature flags, experiments, and remote config declaratively via a Git repository.

Workflow can be broken down into 3 steps:

  • 1️⃣ Manage feature flags, experiments, and remote config in your Git repository
  • 2️⃣ Trigger CI/CD pipeline to generate and upload datafiles (static JSON files) to your CDN
  • 3️⃣ Fetch and evaluate datafiles in your applications using Featurevisor SDKs

More documentation available at https://featurevisor.com.

Supported features:

  • 🚩 Feature flags: classic on/off switches
  • 🆎 Experimentation: a/b and multivariate tests
  • 👥 Segmentation: reusable conditions for targeting groups of users
  • ↗️ Gradual rollouts: avoid big bang releases, and go from 0% to 100% rollout gradually
  • 🔧 Variables: store key/value pairs for remote config namespaced under each feature
  • 🎯 Consistent bucketing: makes sure same user gets same variation across devices/sessions
  • 🌏 Multiple environments: Go beyond just staging and production to fit your needs
  • 🏷️ Tagging: Load only features relevant to your application, avoiding bloat
  • 👁️ Tracking: Track experiment activations with your favourite analytics tool

SDK support:

Quick start

You are recommended to see a more detailed quick start guide here: https://featurevisor.com/docs/quick-start/.

The whole process can be broken down into 3 steps:

Step 1: Create a Featurevisor project

Use npx to scaffold a new Featurevisor project:

$ mkdir my-featurevisor-project && cd my-featurevisor-project

$ npx @featurevisor/cli init
$ npm install

You can now create and manage your feature flags, experiments, and remote config in this directory expressed as YAMLs.

See the building block guides here:

  • Attributes: building block for conditions
  • Segments: conditions for targeting users
  • Features: feature flags and variables with rollout rules

Step 2: Build and deploy datafiles

Once the project is initialized, you can build your datafiles (JSON files containing configuration of your feature flags):

$ npx featurevisor build

You will find the output in datafiles directory, that you can upload to your CDN.

See further guides here:

A fully functioning example for deploying with Cloudflare and GitHub Actions (for free) is available here.

Step 3: Consume datafiles with Featurevisor SDKs

You can now consume the datafiles from your CDN in your applications directly using Featurevisor SDKs.

For Node.js and browser environments, install the JavaScript SDK:

$ npm install --save @featurevisor/sdk

Now you can initialize the SDK with the URL of your datafile, and evaluate your feature flags:

import { createInstance } from "@featurevisor/sdk";

// fetch datafile
const DATAFILE_URL = "https://cdn.yoursite.com/datafile.json";
const datafileContent = await fetch(DATAFILE_URL)
  .then((res) => res.json());

// initialize the SDK
const f = createInstance({
  datafile: datafileContent,
});

// set user context
f.setContext({
  appVersion: "1.0.0",
  userId: "user-123",
  country: "nl",
});

// evaluate values
const isEnabled = f.isEnabled("myFeatureKey");
const variation = f.getVariation("myFeatureKey");
const variable  = f.getVariable("myFeatureKey", "someVariableKey");

Learn more about SDK usage here: https://featurevisor.com/docs/sdks/javascript/.

Packages

Package Version Description
@featurevisor/cli CLI package
@featurevisor/core Core package used by CLI
@featurevisor/react React package
@featurevisor/sdk Universal SDK for both Node.js and browser
@featurevisor/site Static site generator for your project
@featurevisor/types Common typings
@featurevisor/vue Vue.js package

License

MIT © Fahad Heylaal