Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/Xabaril/Esquio into featu…
Browse files Browse the repository at this point in the history
…res/net50
  • Loading branch information
unaizorrilla committed Nov 30, 2020
2 parents 9f3ad1c + 794ad67 commit c021b3b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

[![Documentation Status](https://readthedocs.org/projects/esquio/badge/?version=latest)](https://esquio.readthedocs.io/en/latest/?badge=latest)

[![Blimp demo badge](https://blimpup.io/demo-badge.svg?repo=https://github.com/Xabaril/Esquio)](https://blimpup.io/preview-env/?repo=https://github.com/Xabaril/Esquio&port=app:80&port=ui:80&composeFiles=build/docker-compose-demo-with-ui-sqlserver-with-reference-images.yml)

## About [Esquio](https://esquio.readthedocs.io)

Esquio is a [Feature Toggles (aka Feature Flags)](https://martinfowler.com/articles/feature-toggles.html) and A/B testing framework for .NET Core 3.0. Feature Toogle is a powerful technique that allows developers to deliver new functionality to users withouth changing code. Provides an alternative to to mantain multiples branches (aka feature branches), so any feature can be tested even before it is completed and ready for the release. We can release a version of our product with not production ready features. These non production ready features are hidden (toggled) for the broader set of users but can be enabled to any subset of testing or internal users we want them to try the features.We can use feature toogling to enable or disable features during run time.
Expand All @@ -24,14 +22,6 @@ Maintained by [awesome community contributors](https://github.com/Xabaril/Esquio
For project documentation, please visit [readthedocs](https://esquio.readthedocs.io).


## Temporary demo environment

If you want to play around with Esquio without running it locally, you can [boot a personal demo copy](https://blimpup.io/preview-env/?repo=https://github.com/Xabaril/Esquio&port=app:80&port=ui:80&composeFiles=build/docker-compose-demo-with-ui-sqlserver-with-reference-images.yml) from your browser without downloading or setting up anything.

Clicking the [link](https://blimpup.io/preview-env/?repo=https://github.com/Xabaril/Esquio&port=app:80&port=ui:80&composeFiles=build/docker-compose-demo-with-ui-sqlserver-with-reference-images.yml) boots this repo in the Blimp cloud, and creates a public URL for you to access it.

To use the demo, you can follow along with [this presentation at the ASP.NET Community Standup](https://www.youtube.com/watch?v=qotnVlgYd8c&t=1093). You can skip the docker-compose step and simply use the "Connect" buttons in the sandbox to access the demo app and the Esquio UI.

## How to build
Esquio is built against the latest NET Core 3.

Expand Down
11 changes: 11 additions & 0 deletions docs/source/started/aspnetcore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,17 @@ The ``FeatureTagHelper`` supports ``Include`` and ``Exclude`` attributes:
* Include: *A comma-separated list of feature names to be evaluated. If any feature is not active, this tag helper suppresses the content.*
* Exclude: *A comma-separated list of feature names to be evaluated. If any feature is active, this tag helper suppresses the content.*

Make sure you add the taghelper on your ``_ViewImports.cshtml`` file with:

.. code-block:: html

...
@using Esquio
@using Esquio.Abstractions
@using Esquio.AspNetCore
...
@addTagHelper *, Esquio.AspNetCore

SPA and Native Apps
^^^^^^^^^^^^^^^^^^^^^^

Expand Down
10 changes: 5 additions & 5 deletions docs/source/toggles/aspnetcore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ This toggle enables its feature if the hostname of the client instance is in the
"Type": "Esquio.AspNetCore.Toggles.HostNameToggle",
"Parameters":
{
"Environments": "mycompany.org;en.domain.com"
"HostNames": "mycompany.org;en.domain.com"
}
}
]
Expand Down Expand Up @@ -293,7 +293,7 @@ This toggle enables its feature if the request country is in the list (Ip geoloc
"Type": "Esquio.AspNetCore.Toggles.Ip2CountryToggle",
"Parameters":
{
"Environments": "ES;IT"
"Countries": "ES;IT"
}
}
]
Expand Down Expand Up @@ -321,7 +321,7 @@ This toggle enables its feature if the identity role is in the list.
"Type": "Esquio.AspNetCore.Toggles.RoleNameToggle",
"Parameters":
{
"Users": "betauser;beta"
"Roles": "betauser;beta"
}
}
]
Expand Down Expand Up @@ -349,7 +349,7 @@ This toggle enables its feature if the host IP address is in the list.
"Type": "Esquio.AspNetCore.Toggles.ServerIpAddressToggle",
"Parameters":
{
"Users": "11.22.44.88;11.22.33.44"
"IpAddresses": "11.22.44.88;11.22.33.44"
}
}
]
Expand Down Expand Up @@ -379,7 +379,7 @@ This toggle enables its feature if the request user agent browser is in the list
"Type": "Esquio.AspNetCore.Toggles.UserAgentToggle",
"Parameters":
{
"Users": "Mozilla/5.0;Chrome/81.0.4"
"Browsers": "Mozilla/5.0;Chrome/81.0.4"
}
}
]
Expand Down

0 comments on commit c021b3b

Please sign in to comment.