Code Monkey home page Code Monkey logo

snowplow-incubator / snowplow-browser-plugin-simple-template Goto Github PK

View Code? Open in Web Editor NEW
1.0 8.0 2.0 80 KB

A simple template for creating and publishing a Browser Plugin for the Snowplow JavaScript Trackers

Home Page: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/javascript-trackers/

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

JavaScript 55.16% TypeScript 44.84%
plugin plugin-architecture snowplow snowplow-javascript-tracker data

snowplow-browser-plugin-simple-template's Introduction

Snowplow Browser Plugin Simple Example

License

This template demonstrates how to create a Browser Plugin to be used with @snowplow/browser-tracker.

This example can be cloned, modified and then published to npm.

Maintainer quick start

Requires Node (10+).

Setup repository

$ npm install
$ npm test
$ npm run build

Package Publishing

Update banner.js and package.json with your information.

We advise naming the package snowplow-browser-plugin-* where * describes what this plugin does.

npm run build
npm login
npm publish

Example Usage from npm

Initialize your tracker with the SimpleContextTemplate:

import { newTracker } from '@snowplow/browser-tracker';
import { SimpleContextTemplate } from 'snowplow-browser-plugin-simple-template';

newTracker('sp1', '{{collector}}', { plugins: [ SimpleContextTemplate() ] });

Example Usage with tag based tracker

Assuming sp.js or sp.lite.js has been loaded on window.snowplow, and this plugin is published on npm:

window.snowplow('addPlugin', 
  "https://cdn.jsdelivr.net/npm/snowplow-browser-plugin-simple-template@latest/dist/index.umd.min.js",
  ["snowplowSimpleTemplate", "SimpleContextPlugin"]
);

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

Copyright (c) 2021 Snowplow Analytics Ltd.

All rights reserved.

snowplow-browser-plugin-simple-template's People

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

jethron pavasg01

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.