diff --git a/CREATE_FEATURE_FLAG.md b/CREATE_FEATURE_FLAG.md deleted file mode 100644 index 6c63240..0000000 --- a/CREATE_FEATURE_FLAG.md +++ /dev/null @@ -1,17 +0,0 @@ -## High Level Steps to Create a Split -1- Create a new Split - -Go to the Splits Section by clicking 'Split' in the upper left section of the header and click the blue button 'New Split' in the upper right of the main content. -![New Split](/images/new_split.png?raw=true "New Split") - -2- Specify a Name, select a traffic type, description (optional) and Save - -![Create Split](/images/create_split.png?raw=true "Create Split") - -3- Add the split to an environment - -![Add to Environment](/images/add_to_env.png?raw=true "Add to Environment") - -4- Finish the configuration and save - -![Configure Split](/images/configure_in_env.png?raw=true "Configure Split") \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt index e8027ad..64356fa 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,13 +1,202 @@ -Copyright 2017 Split Software, Co. -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ - http://www.apache.org/licenses/LICENSE-2.0 + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2026 Harness Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..4c34595 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,3 @@ +Harness FME Browser SDK example copyright 2026 Harness Inc. (https://harness.io/). + +Originally developed by Split Software, Inc. (https://www.split.io/). Copyright 2017-2023 Split Software, Inc. \ No newline at end of file diff --git a/README.md b/README.md index ba1e6c7..3745dd6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,52 @@ -## Example Demo Page to show Split JavaScript SDK and JavaScript Browser SDK +# Examples for FME Browser SDK and FME JavaScript SDK -These are two single pages that show how to set up the [JavaScript SDK](https://github.com/splitio/javascript-client) and the [JavaScript Browser SDK](https://github.com/splitio/javascript-browser-client). Follow the instructions below to make the changes needed using the information obtained from Split user interface. +[![Documentation](https://img.shields.io/badge/FME_Browser_SDK-documentation-informational)]([https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/net-sdk/](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk)) [![Documentation](https://img.shields.io/badge/FME_JavaScript_SDK-documentation-informational)]([https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/net-sdk/](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk)) +## Table of Contents +**[Intro](#intro)**
+**[Requirements](#requirements)**
+**[Quickstart](#quickstart)**
+**[Further Reading](#further-reading)**
-### Get started +## Intro - * Log in to the Split user interface, go to the "Admin Tab", copy an SDK key of type "Client-side", and assign it to the `authorizationKey` config param in either the `index-js-sdk.html` file or `index-js-browser-sdk.html` file, in order to try the JavaScript SDK or JavaScript Browser SDK respectively. - * [Create a feature flag](CREATE_FEATURE_FLAG.md) and assign its name to the variable `featureFlagName` in the HTML file. - * Open the HTML file in your browser. +These single web page examples show you how to set up the [FME Browser SDK](https://github.com/splitio/javascript-browser-client) and the [FME JavaScript SDK](https://github.com/splitio/javascript-client) to evaluate an FME feature flag and send an event. + +![Web page running Browser SDK example](https://github.com/splitio/example-javascript-browser/blob/master/images/example-browser-sdk.png) + +The Browser SDK is optimized for web browsers and built on top of the JavaScript SDK core modules. To compare between the SDK versions, see also the [JavaScript to Browser SDK Migration Guide](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/examples/browser-sdk-migration). + +## Requirements + +To run the example, you need: +* just a web browser +* (optional) [Python](https://www.python.org/downloads/) + +## Quickstart + +This repo contains three examples: +* `index-js-sdk.html` - shows how to set up the JavaScript SDK +* `index-js-browser-sdk.html` - shows how to set up the Browser SDK (similar to JavaScript SDK, but optimized for web browsers) +* `index-js-browser-sdk-full.html` - shows how to set up the Browser SDK, with logging + +To run the SDK on the web page: + +1. Log in to [Harness](https://app.harness.io) or create a free account. +1. Navigate to **Feature Management & Experimentation** > **FME Settings** > **Projects** > **View** > **SDK API Keys** and copy a client-side SDK API key for one of your FME environments. +1. Paste your SDK API key as the value of the `sdkKey` variable in the HTML file. +1. Create a feature flag, initiate the FME environment, define the flag's targeting rules, and assign the flag name to the `featureFlagName` variable in the HTML file. +1. Open the HTML file in your browser and see the treatment for the feature flag. + + You can also serve the HTML files using Python as a lightweight web server, by running `python3 -m http.server` in a command prompt from your local `example-javascript-browser` folder. Then you can navigate to the pages on `localhost`, for example: + + [http://localhost:8000/index-js-browser-sdk.html](http://localhost:8000/index-js-browser-sdk.html) + + ## Further Reading + +See the [FME JavaScript SDK](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk) and the [FME Browser SDK](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk) docs to learn about configuration options, optimizations, and event tracking. + +For more information about feature flags, see our [Feature Management](https://developer.harness.io/docs/feature-management-experimentation/feature-management) documentation. + +------- + +[Harness](https://harness.io) is a software delivery platform that delivers intelligent AI automation, so your team ships code faster, safer, and smarter. diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000..974cd2b Binary files /dev/null and b/favicon.ico differ diff --git a/images/add_to_env.png b/images/add_to_env.png deleted file mode 100644 index 843e8c6..0000000 Binary files a/images/add_to_env.png and /dev/null differ diff --git a/images/configure_in_env.png b/images/configure_in_env.png deleted file mode 100644 index a0b1bf0..0000000 Binary files a/images/configure_in_env.png and /dev/null differ diff --git a/images/create_split.png b/images/create_split.png deleted file mode 100644 index 86b063b..0000000 Binary files a/images/create_split.png and /dev/null differ diff --git a/images/example-browser-sdk.png b/images/example-browser-sdk.png new file mode 100644 index 0000000..8c8be5a Binary files /dev/null and b/images/example-browser-sdk.png differ diff --git a/images/new_split.png b/images/new_split.png deleted file mode 100644 index 3c03821..0000000 Binary files a/images/new_split.png and /dev/null differ diff --git a/index-js-browser-sdk-full.html b/index-js-browser-sdk-full.html new file mode 100644 index 0000000..ade7d2f --- /dev/null +++ b/index-js-browser-sdk-full.html @@ -0,0 +1,81 @@ + + + + + + Hello FME Browser SDK (full) + + + + + + + diff --git a/index-js-browser-sdk.html b/index-js-browser-sdk.html index e803029..45d79d6 100644 --- a/index-js-browser-sdk.html +++ b/index-js-browser-sdk.html @@ -2,43 +2,79 @@ - Hello Split - - + + Hello FME Browser SDK + + diff --git a/index-js-sdk.html b/index-js-sdk.html index 996a21b..1a75e7f 100644 --- a/index-js-sdk.html +++ b/index-js-sdk.html @@ -2,42 +2,80 @@ - Hello Split - + + Hello FME JavaScript SDK + + diff --git a/index.css b/index.css new file mode 100644 index 0000000..237e07c --- /dev/null +++ b/index.css @@ -0,0 +1,24 @@ +html { + min-height: 100vh; +} + +body { + color: white; + font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", "Liberation Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; + font-size: large; + font-weight: lighter; + text-align: center; + background-image: linear-gradient(to bottom, #87b8d1, #ffffff); + background-repeat: no-repeat; + background-attachment: fixed; +} + +.blue-button { + border: 1px solid gray; + letter-spacing: .28px; + border-radius: 5px; + padding: 8px 12px; + font-size: 14px; + font-weight: 500; + line-height: 14px; +}