{"id":13605686,"url":"https://github.com/Soluto/tweek","last_synced_at":"2025-04-12T05:34:20.662Z","repository":{"id":37430820,"uuid":"52024438","full_name":"Soluto/tweek","owner":"Soluto","description":"Tweek - an open source feature manager","archived":false,"fork":false,"pushed_at":"2023-09-28T17:12:48.000Z","size":15138,"stargazers_count":351,"open_issues_count":221,"forks_count":50,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-12-07T02:46:51.353Z","etag":null,"topics":["ab-testing","backend","configuration","continuous-delivery","devops","experiments","feature-flags","feature-toggles","microservices","soluto-open-source"],"latest_commit_sha":null,"homepage":"https://tweek.soluto.io","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Soluto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-02-18T17:15:29.000Z","updated_at":"2024-09-07T21:11:35.000Z","dependencies_parsed_at":"2023-02-16T02:31:03.664Z","dependency_job_id":"e3a34fbd-0de1-4f13-ba4d-17c93267db52","html_url":"https://github.com/Soluto/tweek","commit_stats":null,"previous_names":[],"tags_count":230,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soluto%2Ftweek","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soluto%2Ftweek/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soluto%2Ftweek/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Soluto%2Ftweek/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Soluto","download_url":"https://codeload.github.com/Soluto/tweek/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248524645,"owners_count":21118612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ab-testing","backend","configuration","continuous-delivery","devops","experiments","feature-flags","feature-toggles","microservices","soluto-open-source"],"created_at":"2024-08-01T19:01:01.593Z","updated_at":"2025-04-12T05:34:19.943Z","avatar_url":"https://github.com/Soluto.png","language":"C#","readme":"# \u003cimg src=\"https://tweek.soluto.io/assets/logo-with-background.png\" width=\"400\" /\u003e\n\n[![Github build status](https://github.com/Soluto/tweek/workflows/Main/badge.svg?branch=master)](https://github.com/Soluto/tweek/actions?query=workflow%3AMain+branch%3Amaster) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/soluto/tweek/blob/master/LICENSE.md) [![Slack](https://tweek-slack.now.sh/badge.svg)](https://join.slack.com/t/tweek/shared_invite/zt-gtbko33a-UjCs2bnZCSvSELziIAfu5g)[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\ntweek@soluto.com\n\n### What is Tweek?\n\nTweek is an open source feature management solution for customizing applications and system behavior without deploying new code.\n\nTweek aims to be a complete open-source alternative to other industry feature/configuration/experiment management solutions such as Facebook's Gatekeeper, LinkedIn's XLNT, Dropbox's Stormcrow and other commercial SaaS solutions.\n\n#### Features\n\n- Feature toggles, gradual release\n- Multi-variant experiments, A/B testing\n- Built-in editor with user friendly UI\n- Hierarchical configurations\n- Advanced targeting of users/groups\n- Dependencies between features\n- Customizable schema/domain model\n- Auditing\n- Integrated storage for saving context\n- Container friendly\n- Integrated OAuth support\n- Pluggable storage backend\n- Simple RESTful api for fetching configurations\n- Scalable\n\n### Getting started\n\nThe easiest way to start evaluating Tweek is to run it locally on Docker. Make sure you have the latest [docker (for windows/mac/etc..)](https://www.docker.com/get-docker) version installed (17-06+).\n\n#### Running Tweek\n\n- Clone the repo (`git clone https://github.com/Soluto/tweek.git`).\n- [optional] Pull images, run `yarn docker-compose pull --parallel` (optional for getting started fast with Tweek as it's skip build).\n- [optional] Newer versions of docker-compose support parallel build, so you can use `yarn docker-compose build --parallel` for faster build.\n\n### Using Docker Compose\n\n- Run (`yarn start`) - this might take a few minutes on the first time.\n\n### Using Tilt\n\nTilt is a CLI tool that can be used to create an optimal development environment for multi-container apps such as Tweek. It support automatic rebuilding of images and re-running of containers on files' changes.\nAdditionally, it support more complex live reloading scenarios, like Tweek Editor (React app).\nTweek uses Tilt on top of docker-compose for easier and (usually) faster developer experience (compared to Tilt with k8s).\n\n- Install Tilt (https://docs.tilt.dev/install.html)\n- tilt up\n\n### Using Kubernetes\n\n- Install Skaffold (https://github.com/GoogleContainerTools/skaffold)\n- Run `skaffold dev --port-forward=false`\n- Wait for the environment to be stable (this will take about 10 mins on the first time due to building all images, afterward it can take about 2 mins for environment to stabilize)\n\n### Troubleshooting\n\n- Run (`yarn start --build`) to rebuild all images and start Tweek.\n\n#### Edit your first key\n\nAfter setting up our environment, we're going to create our first key.\nKeys in Tweek are the most basic building blocks, and they represent a container for dynamic value that affect feature behaviors.\nOur first key will be a key that is responsible for the color of a \"sign up\" button.\n\n- Open http://localhost:8081/login in browser.\n- Login\n  - User Basic auth (user: admin-app, password: 8v/iUG0vTH4BtVgkSn3Tng==)\n  - Can also use OIDC mock server login button for testing OIDC (user: User, password: pwd)\n- Go to keys page.\n- Click on \"Add Key\"\n- Type my_app/sign_button/color\n- Set value type to String\n- Add default value \"red\"\n- Save changes\n- Click on \"Add Rule\"\n- Set Property to Country (user) and set \"=\" and \"Canada\" in the other fields\n- In Rule value set the value \"blue\"\n- Click \"Save changes\"\n\nMore on [keys and paths](https://tweek.soluto.io/concepts/keys/keys-ands-paths)\n\n#### Querying Tweek\n\nUse curl/postman/chrome to fire GET Request:\n\n- http://localhost:8081/api/v2/values/my_app/sign_button/color -\u003e expected to be \"red\"\n- http://localhost:8081/api/v2/values/my_app/sign_button/color?user.Country=canada -\u003e expected to be \"blue\"\n- http://localhost:8081/api/v2/values/my_app/sign_button/_?user.Country=canada -\u003e expected to be {\"color\":\"blue\"}\n\nUsing the rest api, an application can query Tweek for getting the right set of values for each specific user.\nMore on Tweek [Rest api](https://tweek.soluto.io/reference/openapi).\n\n#### Adding context data\n\nTweek provide UI and rest api for editing context.\n\n- Go to context\n- Set Identity Type to User\n- Set User id to John\n- Click enter\n- Set value \"Canada\" for property Country\n\nAfter that, we can query Tweek API with:\n\n- http://localhost:8081/api/v2/values/my_app/sign_button/color?user=john -\u003e expected to be \"blue\"\n\nYou can also use the api for updating Tweek context:\n\n- curl -X POST http://localhost:8081/api/v2/context/user/john \\\n  -H 'content-type: application/json' \\\n  -H 'x-client-id: admin-app' \\\n  -H 'x-client-secret: 8v/iUG0vTH4BtVgkSn3Tng==' \\\n  -d '{\n  \"country\": \"Canada\"\n  }'\n\nMore on [Context.](https://tweek.soluto.io/concepts/context/intro-to-context)\n\n#### Gradual feature release\n\nCreate a new key in the editor \"my_app/sign_button/is_enabled\" with value type \"boolean\" and default value False.  \nAdd a new rule, remove all conditions, set the the rule value to gradual release with 50%.\nTry querying configuration with different users and you'll have different results.\n\n- http://localhost:8081/api/v2/values/my_app/sign_button/is_enabled?user=barny\n- http://localhost:8081/api/v2/values/my_app/sign_button/is_enabled?user=robin\n- http://localhost:8081/api/v2/values/my_app/sign_button/is_enabled?user=ted\n- http://localhost:8081/api/v2/values/my_app/sign_button/is_enabled?user=lily\n- etc...\n\nMore on how multi-variant keys work in Tweek. (link)\n\n### Deployment to production\n\n### FAQ\n\n- Who's using Tweek?  \n  Tweek is used in large-scale production deployment at Soluto.\n- How do I generate ssh keys and a pfx file for use in production?  \n  There's a script for this purpose in `utils/generate_keys.sh`\n- I found a security vulnerability, should I open an issue about it?  \n  No. Please send an email to `security@soluto.com`.\n\n### Related projects\n\n[Tweek-Clients](https://github.com/Soluto/tweek-clients) - Tweek REST clients  \n[Tweek.JPad](https://github.com/soluto/tweek.jpad) - Tweek's internal rules engine\n\n### Additional Resources\n\n- https://martinfowler.com/articles/feature-toggles.html\n- https://en.wikipedia.org/wiki/Feature_toggle\n","funding_links":[],"categories":["C# #"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSoluto%2Ftweek","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSoluto%2Ftweek","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSoluto%2Ftweek/lists"}