Skip to content
/ Flaggy Public

Flaggy provides easy to use tools that help with managing feature flag context.

Notifications You must be signed in to change notification settings

Nhollas/Flaggy

Repository files navigation

Flaggy

Flaggy is a open-source tool designed to simplify the management of feature flag contexts. It provides an intuitive user interface for setting up and distributing flag contexts within your team or anyone who wants to look at a feature with the safety a feature flag provides.

Currently, Flaggy supports LaunchDarkly as a feature flag provider, but the codebase is designed to be extensible, and contributions to support more providers are welcome.

The running application

Our UI will generate you with a link like this:

https://flaggy-six.vercel.app/api/flag/context?data={"contexts":[{"kind":"user","attributes":{"key":"user-123","plan":"premium","age":"25"}},{"kind":"purchase","attributes":{"key":"purchase-123","basket-id":"basket-abEz8if"}}]}&redirectUrl=https://flaggy-six.vercel.app/

Using the link will persist the context you setup up on the site, meaning that if you navigate away or refresh the page, your original context will still be in place. By default this is set to 1 hour upon use, but you can clear this via the UI.

Every flag evaluation that is made to Launchdarkly either on the server or client will be given this context.

You can also use a previously generated link to quickly get back the context you setup in the Context Builder the builder saving you time and effort.

The running application

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

  • Node.js
  • npm

Cloning the Repository

To clone the repository, run the following command in your terminal:

git clone https://github.com/Nhollas/Flaggy.git

Setting Up The Project

  1. Navigate to the project directory:
cd Flaggy
  1. Install Dependencies:
npm install
  1. Setup environment variables:

copy the .env.example file to a new file called .env.local.

copy .env.example .env.local

Replace the Launchdarkly values, they can be found under your specific project here:

https://app.launchdarkly.com/settings/projects

Run Development Server

Finally, run the development server:

npm run dev

Now you can open http://localhost:3000 with your browser to see the application.

Contributing

Flaggy is an open-source project, and contributions are always welcome! If you have a feature request, bug report, or proposal for code refactor, please feel free to open an issue or submit a pull request.

About

Flaggy provides easy to use tools that help with managing feature flag context.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published