mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

Unleash is the open source feature toggle service.

activation-strategies continuous-delivery continuous-deployment devops devtool experiments feature feature-flags feature-toggle feature-toggles feature-toggling hacktoberfest toggles unleash variants

Go to file

ivaosthu 52fcfb4a2b Remove /api/client/seen-toggles as we don't need it anyway		2020-02-20 08:30:42 +01:00
bin	remove console...	2020-02-20 08:30:41 +01:00
docs	Remove client_strategies table	2020-02-20 08:30:42 +01:00
lib	Remove /api/client/seen-toggles as we don't need it anyway	2020-02-20 08:30:42 +01:00
migrations	Remove client_strategies table	2020-02-20 08:30:42 +01:00
scripts
test	Remove client_strategies table	2020-02-20 08:30:42 +01:00
.editorconfig
.eslintignore
.eslintrc
.gitignore	use ava as testrunner	2020-02-20 08:30:39 +01:00
.travis.yml	send coverage after success	2020-02-20 08:30:39 +01:00
LICENSE
migrator.js	replace commander with yargs	2020-02-20 08:30:41 +01:00
package.json	fix lint	2020-02-20 08:30:41 +01:00
Procfile	Update Procfile	2020-02-20 08:30:38 +01:00
README.md	fix typos	2020-02-20 08:30:41 +01:00
server.js	cleanup bin	2020-02-20 08:30:40 +01:00
shift.sh	send toggleName back	2020-02-20 08:30:42 +01:00

README.md

Unleash

Warning: We will soon release the first official version of Unleash (1.0.0). If you want to test the previous package see previous tag

Unleash is a feature toggle system, that gives you a great overview over all feature toggles across all your applications and services. It comes with client implementations for Java and Node, and it is fairly easy to develop client implementation for your favourite language.

The main motivation for doing feature toggling is to decouple the process for deploying code to production and releasing new features. This helps reducing risk, and allow us to easily manage which features to enable

Feature toggles decouple deployment of code from release of new features

This repo contains the unleash-server, which contains the admin UI and a place to ask for the status of features. In order to make use of unleash you will also need a client implementation.

Activation strategies

It's fine to have a system for turning stuff on and off. But some times we want more granular controll, we want to decide who to the toggle should be enabled for. This is where activation strategies comes in to the picture. Activation strategies takes arbitrary config and allows us to enable a toggle in various ways.

Common activation strategies includes:

Active For users with a specified userId
GradualRollout to X-percent of our users
Active for our beta users
Active only for application instances running on host x.

Read more about activation strategies in docs/activation-strategies.md

Client implementations

unleash-client-java
unleash-client-node
(your implementation here!)

Client implementations makes it is easy for developers to check whether a toggle is enabled or disabled.

if(unleash.isEnabled("AwesomeFeature")) {
  //do some magic
} else {
  //do old boring stuff
}

Running Unleash

Requirements

You will need a PostreSQL 9.3+ database instance to be able to run Unleash.

When starting Unleash you must specify a database uri (can be set as environment variable DATABASE_URL) which includes a username and password, that have rights to migrate the database.

Unleash will, at startup, check whether database migration is needed, and perform necessary migrations.

Start Unleash

The simplest way to get started: (database-url can also be set as a environment variable: DATABASE_URL)

$ npm install unleash-server -g
$ unleash -d postgres://unleash_user:passord@localhost:5432/unleash -p 4242

Unleash started on port:4242

You can also require Unleash as a lib and expand it with more options. Read more about this feature in the getting started guide.

Project details

Project Roadmap

Developer Guide

If you want to contribute to this project you are encouraged to send issue request, or provide pull-requests. Please read the unleash developer guide to learn more on how you can contribute.

Run with docker

We have made a separate project which runs unleash inside docker. Please see unleash-docker