Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/managed-components/segment
Owner: managed-components
License: other
Created: 2023-02-20T17:55:33.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-04-05T05:04:00.000Z (9 months ago)
Last Synced: 2024-09-19T03:11:21.497Z (4 months ago)
Language: TypeScript
Size: 441 KB
Stars: 1
Watchers: 4
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-zaraz - Segment
awesome-zaraz - Segment

README

# Segment Managed Component

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/snapchat?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

### Segment Source Write Key `string` _required_

`writeKey` - You need to create an HTTP API source, and enter the Write Key here. [Learn more](https://segment.com/docs/connections/find-writekey/)

### Type `string` _required_

`callType` - Options are:

- Page - Record page views on your website
- Track - Record the actions your users perform
- Identify - Tie a user to their actions
- Alias - Associate one identity with another identity
- Group - Associate an individual user with a group

## 🧱 Fields Description

### Event Name `string` _required_

`event` - Name of the action that a user has performed. See the [Event field docs](https://segment.com/docs/connections/spec/track#event) for more details.

### Page Name `string`

`name` - Name of the page. For example, most sites have a "Signup" page that can be useful to tag, so you can see users as they move through your funnel.

### Anonymous ID `string`

`anonymousId` - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. See the [Identities docs](https://segment.com/docs/connections/spec/identify#identities) for more details.

### User ID `string`

`userId` - Unique identifier for the user in your database. See the [Identities docs](https://segment.com/docs/connections/spec/identify#identities) for more details.

### Previous ID `string`

`previousId` - The existing ID you’ve referred to the user by. It might be an Anonymous ID assigned to that user or a User ID you previously identified them with.

## 📝 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)):

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