1
0
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.
Go to file
Nnenna Ndukwe 803a55d103
update canary deployments sections in examples (#7363)
<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

Cleaned up the canary deployment sections

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->
2024-06-14 07:22:19 -04:00
.do
.floe docs: spelling and grammar (#6007) 2024-01-23 19:52:10 +01:00
.github Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
.husky Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
.vscode
coverage
docker chore(deps): bump braces from 3.0.2 to 3.0.3 in /docker (#7370) 2024-06-13 19:51:17 +02:00
docs/api/oas
examples
frontend feat: menubar is not dependant on query params anymroe (#7399) 2024-06-14 12:26:52 +03:00
scripts Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
src feat: optimize search store by removing inline EXISTS (#7394) 2024-06-14 10:26:12 +03:00
test-migrations Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
website update canary deployments sections in examples (#7363) 2024-06-14 07:22:19 -04:00
.dockerignore Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
.editorconfig
.gitignore Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
.lycheeignore chore: added www.java.com to lychee ignore 2024-06-12 09:41:08 +02:00
.mergify.yml
.node-version chore(deps): update dependency node to v20.14.0 (#6617) 2024-05-31 15:03:25 +02:00
.nvmrc Node20 (#7095) 2024-05-23 14:14:09 +02:00
app.json chore: Update app.json (#7078) 2024-05-20 14:18:48 +02:00
biome.json Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
CHANGELOG.md chore: bump version to 6.0.3+main 2024-06-14 08:41:27 +00:00
cliff.toml
CODE_OF_CONDUCT.md
CODEOWNERS chore: make Alvin CODEOWNER for docs (#6547) 2024-03-15 07:25:08 -04:00
CONTRIBUTING.md Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
docker-compose.yml
Dockerfile Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373) 2024-06-12 13:25:51 +02:00
LICENSE
package.json chore: bump version to 6.0.3+main 2024-06-14 08:41:27 +00:00
README.md chore: remove toggle reference apart from existing links (#7148) 2024-05-27 10:46:26 +03:00
renovate.json fix: freezing navigation (#6090) 2024-01-31 11:33:39 +01:00
tsconfig.json fix(import): making all imports relative and removing baseUrl (#5847) 2024-01-17 15:33:03 +02:00
USERS.md chore: t-mobile added as a proud user (#6208) 2024-02-13 11:18:59 +01:00
yarn.lock chore(deps): bump braces from 3.0.2 to 3.0.3 (#7393) 2024-06-13 17:56:02 +00:00

What is Unleash?

Unleash is a powerful open source solution for feature management. It streamlines your development workflow, accelerates software delivery, and empowers teams to control how and when they roll out new features to end users. With Unleash, you can deploy code to production in smaller, more manageable releases at your own pace.

Feature flags in Unleash let you test your code with real production data, reducing the risk of negatively impacting your users' experience. It also enables your team to work on multiple features simultaneously without the need for separate feature branches.

Unleash is the most popular open source solution for feature flagging on GitHub. It supports 15 official client and server SDKs and over 15 community SDKs. You can even create your own SDK if you wish. Unleash is compatible with any language and framework.


Getting Started with Unleash

1. Setting Up Unleash

To get started with Unleash, you need git and docker installed on your machine.

Execute the following commands:

git clone git@github.com: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 flag

Checking the state of a feature flag 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 flag 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.

📖 Learn more about the principles of building and scaling feature flag solutions.


Contribute to Unleash

Unleash is the largest open source feature flag solution on GitHub. Building Unleash is a collaborative effort, and we owe a lot of gratitude to many smart and talented individuals. Building it together with the 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