• Stars
    star
    10,934
  • Rank 3,099 (Top 0.07 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created about 10 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Open-source feature management solution built for developers.

About Unleash

Unleash is an open source feature management solution. It improves the workflow of your development team and leads to quicker software delivery. Unleash increases efficiency and gives teams full control of how and when they enable new functionality for end users. Unleash lets teams ship code to production in smaller releases whenever they want.

Feature toggles make it easy to test how your code works with real production data without the fear that you'll accidentally break your users' experience. It also helps your team work on multiple features in parallel without each maintaining an separate feature branch.

Unleash is the largest open source solution for feature flagging on GitHub. There's 12 official client and server SDKs and 10+ community SDKs available; you can even make your own if you want to. You can use Unleash with any language and any framework.


Get started in 2 steps

1. Start Unleash

With git and docker installed, it's easy to get started:

Run this script:

git clone [email protected]:Unleash/unleash.git
cd unleash
docker compose up -d

Then point your browser to localhost:4242 and log in using:

  • username: admin
  • password: unleash4all

If you'd rather run the source code in this repo directly via Node.js, see the step-by-step instructions to get up and running in the contributing guide.

2. Connect your SDK

Find your preferred SDK in our list of official SDKs and import it into your project. Follow the setup guides for your specific SDK.

If you use the docker compose file from the previous step, here's the configuration details you'll need to get going:

  • For front-end SDKs, use:
    • URL: http://localhost:4242/api/frontend/
    • clientKey: default:development.unleash-insecure-frontend-api-token
  • For server-side SDKs, use:
    • Unleash API URL: http://localhost:4242/api/
    • API token: default:development.unleash-insecure-api-token

If you use a different setup, your configuration details will most likely also be different.

Check a feature toggle

Checking the state of a feature toggle in your code is easy! The syntax will vary depending on your language, but all you need is a simple function call to check whether a toggle is available. Here's how it might look in Java:

if (unleash.isEnabled("AwesomeFeature")) {
  // do new, flashy thing
} else {
  // do old, boring stuff
}

Run Unleash on a service?

If you don't want to run Unleash locally, we also provide easy deployment setups for Heroku and Digital Ocean:

Deploy to Heroku Deploy to DigitalOcean

Configure and run Unleash anywhere

The above sections show you how to get up and running quickly and easily. When you're ready to start configuring and customizing Unleash for your own environment, check out the documentation for getting started with self-managed deployments, Unleash configuration options, or running Unleash locally via docker.


Online demo

Try out the Unleash online demo.

The Unleash online demo


Community and help โ€” sharing is caring

We know that learning a new tool can be hard and time-consuming. We have a growing community that loves to help out. Please don't hesitate to reach out for help.

Join Unleash on Slack

๐Ÿ’ฌ Join Unleash on Slack if you want ask open questions about Unleash, feature toggling or discuss these topics in general.

๐Ÿ’ป Create a GitHub issue if you have found a bug or have ideas on how to improve Unleash.

๐Ÿ“š Visit the documentation for more in-depth descriptions, how-to guides, and more.


Contribute to Unleash

Building Unleash is a collaborative effort, and we owe a lot of gratitude to many smart and talented individuals. Building it together with community ensures that we build a product that solves real problems for real people. We'd love to have your help too: Please feel free to open issues or provide pull requests.

Check out the CONTRIBUTING.md file for contribution guidelines and the Unleash developer guide for tips on environment setup, running the tests, and running Unleash from source.

Contributors

The Unleash contributors


Features our users love

Flexibility and adaptability

Security and performance

  • Privacy by design (GDPR and Schrems II). End-user data never leaves your application.
  • Audit logs
  • Enforce OWASP's secure headers via the strict HTTPS-only mode
  • Flexible hosting options: host it on premise or in the cloud (any cloud)
  • Scale the Unleash Proxy independently of the Unleash server to support any number of front-end clients without overloading your Unleash instance

Looking for more features?

If you're looking for one of the following features, please take a look at our Pro and Enterprise plans:


Architecture

Read more in the system overview section of the Unleash documentation.


Unleash SDKs

To connect your application to Unleash you'll need to use a client SDK for your programming language.

Official server-side SDKs:

Official front-end SDKs:

The front-end SDKs connects via the Unleash Proxy in order to ensure privacy, scalability and security.

Community SDKs:

If none of the official SDKs fit your need, there's also a number of community-developed SDKs where you might find an implementation for your preferred language (such as Elixir, Dart, Clojure, and more).


Users of Unleash

Unleash is trusted by thousands of companies all over the world.

Proud Open-Source users: (send us a message if you want to add your logo here)

The Unleash logo encircled by logos for Finn.no, nav (the Norwegian Labour and Welfare Administration), Budgets, Otovo, and Amedia. The encircling logos are all connected to the Unleash logo.


Migration guides

Unleash has evolved significantly over the past few years, and we know how hard it can be to keep software up to date. If you're using the current major version, upgrading shouldn't be an issue. If you're on a previous major version, check out the Unleash migration guide!


Want to know more about Unleash?

Videos and podcasts

Articles and more

More Repositories

1

unleash-client-node

Unleash client SDK for Node.js
TypeScript
212
star
2

unleash-client-go

Unleash client SDK for Go
Go
135
star
3

unleash-client-java

Unleash client SDK for Java
Java
118
star
4

unleash-docker

Docker container for unleash
Shell
95
star
5

unleash-client-python

Unleash client SDK for Python ๐Ÿ’ก๐Ÿ’ก๐Ÿ’ก
Python
83
star
6

unleash-client-dotnet

Unleash client SDK for .NET
C#
79
star
7

unleash-client-ruby

Unleash client SDK for Ruby
Ruby
58
star
8

unleash-client-php

Unleash client SDK for PHP
PHP
55
star
9

unleash-proxy

Unleash Proxy is used to safely integrate frontend application with Unleash in a secure and scaleable way.
TypeScript
48
star
10

unleash-edge

Rust
45
star
11

unleash-proxy-client-js

A browser client that can be used together with the unleash-proxy.
TypeScript
45
star
12

proxy-client-react

TypeScript
42
star
13

helm-charts

Contains helm-charts for Unleash
Smarty
40
star
14

unleash-client-symfony

Symfony bundle implementing the Unleash server protocol
PHP
32
star
15

unleash-frontend

Unleash Admin UI
TypeScript
30
star
16

unleash-client-nextjs

Unleash SDK for Next.js
TypeScript
27
star
17

unleash-client-rust

Unleash client SDK for Rust language projects
Rust
23
star
18

unleash_proxy_client_flutter

Unleash is a open-source feature flag solution
Dart
15
star
19

yggdrasil

Rust
15
star
20

client-specification

A collection of test specifications to guide client implementations
JavaScript
12
star
21

unleash-proxy-client-swift

Swift
12
star
22

unleash-client-php-wip

PHP client for Unleash
PHP
11
star
23

unleash-examples

Concrete examples of using Unleash
JavaScript
11
star
24

next-unleash

Ease integration with next.js
JavaScript
10
star
25

proxy-client-vue

Vue interface for working with Unleash
TypeScript
8
star
26

unleash-android-proxy-sdk

Kotlin
7
star
27

unleash-docker-community

This is a collection of community maintained extensions to the Unleash Docker containers to make integrating SSO providers easier
Dockerfile
7
star
28

unleash-express

Unleash helper for Express.js
JavaScript
6
star
29

proxy-client-svelte

Svelte interface for working with Unleash
TypeScript
6
star
30

terraform-provider-unleash

Terraform provider for unleash, the Open-source feature management solution
Go
6
star
31

Flask-Unleash

Flask extension to make using Unleash that much easier! ๐Ÿšฆ๐Ÿšฆ๐Ÿšฆ
Python
6
star
32

sdk-integration-tester

Runs integration tests against SDK test servers.
TypeScript
3
star
33

unleash-mini-ws

A small Java-based Workshop to help users get started using Unleash!
Java
2
star
34

unleash-sdk-examples

Example applications using Unleash
TypeScript
2
star
35

actix-template

Template repo for writing web-apps with Actix inside Unleash. See https://github.com/bricks-software/unleash-cloud-operator for an example which does both actix and k8s operator
Rust
2
star
36

unleash-server-api-go

Go client implementation of our admin server API
Go
2
star
37

unleash-react-proxy-sdk

A React SDK to be used together with the Unleash Proxy
2
star
38

unleash-android

Android library to connect to the Unleash frontend API
Kotlin
2
star
39

unleash-event-validator

TypeScript
1
star
40

unleash-spring-boot-starter

Java
1
star
41

actix-middleware-etag

ETag middleware for Actix-web >4
Rust
1
star
42

community-content

Community Content Program for users to be able to contribute to Unleash.
1
star
43

unleash-demo-app

This project is used as a demo app that is runtime-controlled (feature toggled) by Unleash.
TypeScript
1
star
44

unleash-weighter

Python
1
star
45

unleash-client-java-examples

Java
1
star
46

.github

Unleash โœจspecialโœจ files
1
star
47

unleash-action

Unleash integration for GitHub workflows
TypeScript
1
star