https://github.com/managed-components/branch

https://github.com/managed-components/branch

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/managed-components/branch
• Owner: managed-components
• License: other
• Created: 2023-02-20T14:48:22.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-31T11:26:44.000Z (11 months ago)
• Last Synced: 2024-10-13T10:34:51.590Z (3 months ago)
• Language: TypeScript
• Size: 278 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zaraz - Branch

README

        
# Branch Managed Component

## Documentation

Managed Components docs are published at **https://managedcomponents.dev** .

Find out more about Managed Components [here](https://blog.cloudflare.com/zaraz-open-source-managed-components-and-webcm/) for inspiration and motivation details.

[![Released under the Apache license.](https://img.shields.io/badge/license-apache-blue.svg)](./LICENSE)

[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![All Contributors](https://img.shields.io/github/all-contributors/managed-components/branch?color=ee8449&style=flat-square)](#contributors)

## 🚀 Quickstart local dev environment

1. Make sure you're running node version >=18.

2. Install dependencies with `npm i`

3. Run unit test watcher with `npm run test:dev`

## ⚙️ Tool Settings

> Settings are used to configure the tool in a Component Manager config file

### Branch Live Key `string` _required_

The Branch key is the unique idenfier of your branch account. [Get it here ↗        ](https://dashboard.branch.io/account-settings/profile)

### E-commerce tracking `boolean`

Enable forwarding of [Zaraz E-commerce API](https://developers.cloudflare.com/zaraz/web-api/ecommerce/) events to Branch as [Commerce](https://help.branch.io/developers-hub/docs/tracking-commerce-content-lifecycle-and-custom-events#track-commerce-events) or [Content](https://help.branch.io/developers-hub/docs/tracking-commerce-content-lifecycle-and-custom-events#track-content-events) events.

## 📝 License

Licensed under the [Apache License](./LICENSE).

## 💜 Thanks

Thanks to everyone contributing in any manner for this repo and to everyone working on Open Source in general.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Maryna Iholnykova
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!