Giter VIP home page Giter VIP logo

flagsmith / flagsmith-docs Goto Github PK

View Code? Open in Web Editor NEW
37.0 37.0 32.0 27.73 MB

This is the documentation repository for the Docs of Flagsmith. Ship features with confidence using feature flags and remote config. Host yourself or use our hosted version at https://www.flagsmith.com/

Home Page: https://docs.flagsmith.com/

License: BSD 3-Clause "New" or "Revised" License

JavaScript 89.99% CSS 9.45% Shell 0.55%
cd ci continous-deployment continuous-delivery continuous-integration documentation feature-flag feature-flaggers feature-flagging feature-flags feature-toggles flagsmith remote-config

flagsmith-docs's Introduction

Feature Flag, Remote Config and A/B Testing platform, Flagsmith

Stars Docker Pulls Docker Image Size Join the Discord chat Coverage Built with Depot

Flagsmith is an open source, fully featured, Feature Flag and Remote Config service. Use our hosted API, deploy to your own private cloud, or run on-premise.

Flagsmith

Flagsmith makes it easy to create and manage features flags across web, mobile, and server side applications. Just wrap a section of code with a flag, and then use Flagsmith to toggle that feature on or off for different environments, users or user segments.

Get up and running in less than a minute:

curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml
docker-compose -f docker-compose.yml up

The application will bootstrap an admin user, organisation, and project for you. You'll find a link to set your password in your Compose logs:

Superuser "[email protected]" created successfully.
Please go to the following page and choose a password: https://localhost:8000/password-reset/confirm/.../...

Flagsmith Screenshot

Features

  • Feature flags. Release features with confidence through phased roll-outs.
  • Remote config. Easily toggle individual features on and off, and make changes without deploying new code.
  • A/B and Multivariate Testing. Use segments to run A/B and multivariate tests on new features. With segments, you can also introduce beta programs to get early user feedback.
  • Organization Management. Organizations, projects, and roles for team members help keep your deployment organized.
  • Integrations. Easily enhance Flagsmith with your favourite tools.

Trying Flagsmith

Flagsmith hosted SaaS

You can try our hosted version for free at https://flagsmith.com/

Flagsmith Open Source

The Flagsmith API is built using Python 3, Django 2, and DjangoRestFramework 3. You can try the application out using:

We also have options for deploying to AWS, GCP, Azure and On-Premise. If you need help getting up and running, please get in touch!

Overview

This repository is formed of 2 core components, the REST API (found in /api) and the web-based administrator dashboard (found in /frontend) that you can use to manage Flagsmith. Technical documentation for each component can be found at the API and Frontend pages within our Documentation

These two components run as separate applications. The web-based dashboard is a single page app that communicates via REST calls to the API.

Resources

Acknowledgements

Thank you to Uffizzi for providing ephemeral environments to preview pull requests.

flagsmith-docs's People

Contributors

benrometsch avatar dabeeeenster avatar dependabot[bot] avatar eddsaura avatar edsnloor avatar eilgin avatar gagantrivedi avatar geshan avatar imgbot[bot] avatar jaymeyerowitz avatar kevinselwyn avatar khvn26 avatar kyle-ssg avatar lukefanning avatar matthewelwell avatar miguelmoreba avatar milanjaros avatar mnussbaumer avatar mstfymrtc avatar nogoodusername avatar p-maks avatar plumdog avatar prettywood avatar rohitvc avatar rudrankriyam avatar tanayv avatar xrash avatar zefixlluja avatar zeienko-vitalii avatar zoocityboy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

flagsmith-docs's Issues

Load testing profile

Hi, I was wondering if you have done any load testing profiling to know of any potential scalability issues as well as the performance characteristics?

Add Bulk Traits endpoint to API Docs

Should reflect the following cURL example:

curl --location --request POST 'https://edge.api.flagsmith.com/api/v1/bulk-identities' \ --header 'Content-Type: application/json' \ -- header 'X-Environment-Key: <your key>' \ --data-raw '{ "data": [ {"identifier": "identity_1", "traits": [{"trait_key": "foo", "trait_value": "bar"}]}, {"identifier": "identity_2", "traits": [{"trait_key": "foo", "trait_value": "bar"}]} ] }'

gz#57

Clarify whether Flagsmith supports floating point values or not.

You can also optionally store and override String and numerical (int and float) values.
- https://docs.flagsmith.com/managing-features/

Traits are stored natively as either numbers, strings or booleans.
- https://docs.flagsmith.com/managing-identities/#identity-traits

I have not succesfully created a floating point value for a feature flag. Any such attempt leads to the value being coerced into a string. This experiment has not worked for traits either.

What is the actual situation regarding this?

Differences between various Javascript clients

Hi there,

It would be useful to see in the docs, why there are several different client libraries for Javascript in the frontend and for Node. Even the documented APIs seem different.

As a developer, I would want to turn the client into a single npm package, so I can re-use the same logic in my web, mobile and server side projects.
Partly, because I might change providers in the future, but also because if the client version changes and all of them have slightly different roadmaps, I end up having to change all my consumers separately if they all use a bunch of libraries directly.
So abstracting it all away into a single internal package would be the way to go.

Either way, I'm sure there are good reasons for the multitude in JS clients, would be good to document those.

Update JS onchange event details

onChange should be onChange(oldFlags: ...) and Required no/empty. i didnt realise the function passed the previous flags and had a bug, until it clicked looking at other docs needed to call getflags seperately in fn

Terraform provider docs are inconsistent about the JSON object view

One of the green "tip" messages at the top of the page says:

Some API actions require object UUIDs/IDs to be referenced. You can enable the JSON View from your account settings page which will help you access these variables.

But later down in the rest of the page, the instructions say "we're working on adding a JSON View, in the meantime you need to inspect the network requests". This is inconsistent with the green tip message and honestly, having to inspect the network requests isn't a great product experience so it's probably a good idea to get these outdated instructions removed.

gz#498

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.