Awesome Open Source
Awesome Open Source

Feature Flag, Remote Config and A/B Testing platform, Flagsmith

Flagsmith

Flagsmith makes it easy to create and manage features flags across web, mobile, and server side applications. Just wrap a section of code with a flag, and then use Flagsmith to toggle that feature on or off for different environments, users or user segments.

Flagsmith Frontend

The frontend application for Flagsmith. Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations.

This project connects to the Flagsmith API.

Flagsmith Screenshot

Features

  • Feature flags. Release features with confidence through phased rollouts.
  • Remote config. Easily toggle individual features on and off, and make changes without deploying new code.
  • A/B and Multivariate Testing. Use segments to run A/B and multivariate tests on new features. With segments, you can also introduce beta programs to get early user feedback.
  • Organization Management. Organizations, projects, and roles for team members help keep your deployment organized.
  • Integrations. Easily enhance Flagsmith with your favourite tools.

Using Flagsmith Frontend

  • These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
  • See running in production for notes on how to deploy the project on a live system.

Resources

Flagsmith Frontend

The frontend application for https://flagsmith.com/. Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations.

This project connects to the Flagsmith API.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See running in production for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Location Suggested Version
NodeJS >= 6.0.0
npm >= 4.0.0

Installing

npm i

Running

Development

Hot reloading for client / server

npm run dev

Production

You can deploy this application on Heroku and Dokku without making any changes, other than the API URL in project_prod.js

Bundles, minifies and cache busts the project to a build folder and runs node in production. This can be used as part of your deployment script.

npm run bundle
npm start

ENV variables

Variables that differ per environment are exported globally to window.Project in common/project.js, this file gets replaced by a project.js located in env by webpack based on what is set to the "ENV" environment variable (e.g. ENV=prod).

You can override each variable individually or add more by editing ./bin/env.js.

Current variables used between environment.js and common/project.js:

  • API_URL: The API to hit for requests. E.g. https://api.flagsmith.com/api/v1/
  • FLAGSMITH: The flagsmith environment key we use to manage features - Flagsmith runs on Flagsmith.
  • FLAGSMITH_CLIENT_API: The api which the flagsmith client should communicate with. Flagsmith runs on flagsmith. E.g. https://api.flagsmith.com/api/v1/.
  • GA: Google analytics key
  • CRISP_CHAT: Crisp Chat widget key
  • PREVENT_SIGNUP: Determines whether to prevent manual signup without invite. Set it to any value to disable signups.
  • MAINTENANCE: Puts the site into maintenance mode. Set it to any value to disable signups.
  • AMPLITUDE: The ampitude key to use for behaviour tracking.
  • MIXPANEL: Mixpanel analytics key to use for behaviour tracking.
  • SENTRY: Sentry key for error reporting.
  • ASSET_URL: Used for replacing local static paths with a cdn, .e.g https://cdn.flagsmith.com. Defaults to /, i.e. no CDN.
  • BASENAME: Used for specifying a base url path that's ignored during routing if serving from a subdirectory

E2E testing

This project uses Nightwatch for automated end to end testing with chromedriver.

npm test

Built With

  • React
  • Webpack
  • Node

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Getting Help

If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.

Get in touch

If you have any questions about our projects you can email [email protected].

Running locally against your own Flagsmith API instance

We use Flagsmith to manage features we rollout, if you are using your own Flagsmith environment (i.e. by editing project_x.js-> flagsmith) then you will need to have a replica of our flags.

A list of the flags and remote config we're currently using in production can be found here https://gist.github.com/kyle-ssg/55f3b869c28bdd13c02c6688bc76c67f.

Useful links

Website

Product Roadmap

Documentation

Code Examples

Youtube Tutorials


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (68,028
react (5,153
react-native (1,470
continuous-integration (189
continuous-delivery (114
continuous-deployment (92
feature-flags (32
continuous-testing (25
feature-toggles (24

Find Open Source By Browsing 7,000 Topics Across 59 Categories