Skip to content

Commit

Permalink
initial skeleton upload
Browse files Browse the repository at this point in the history
  • Loading branch information
SbDove committed May 24, 2024
0 parents commit f0f2865
Show file tree
Hide file tree
Showing 23 changed files with 3,538 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
test/test-bundle.js
.DS_Store
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# mParticle JS Example Web Integration

A web integration (or a kit) is an extension to the core [mParticle Web SDK](https://github.com/mParticle/mparticle-web-sdk). A kit works as a bridge between the mParticle SDK and a partner SDK. It abstracts the implementation complexity, simplifying the implementation for developers.

A kit takes care of initializing and forwarding information depending on what you've configured in [mParticle's dashboard](https://app.mparticle.com).

## Create Your Own Integration

Detailed instructions on how to implement your own integration with the mParticle Web SDK can be found [here](https://docs.mparticle.com/developers/partners/kit-integrations/javascript-kit), but you can view a quick start guide below.

## Quick Start Guide

1. Fork this repo and `cd` into it locally on your computer.
2. Run `npm install` to install dependencies.
3. Run `KIT=YOURKITNAME npm run watch` to watch files in the `src/` folder, and automatically build your kit to `dist/YOURKITNAME-Kit.iife.js`. Your kit will continuously build as your save your edits.
4. Following examples such as [Optimizely](https://github.com/mparticle-integrations/mparticle-javascript-integration-optimizely), edit files in `src/`.
5. As you map mParticle's methods to your own in `src/`, stub your SDK methods and create tests in `test/tests.js`.
6. Submit a pull request to this repo. A developer from mParticle will review it and once complete, we will help provide you with a repo for your integration.

## Support

Questions? Give us a shout at <[email protected]>

## License

This mParticle Web Kit is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). See the LICENSE file for more info.
Empty file added dist/.keep
Empty file.
Loading

0 comments on commit f0f2865

Please sign in to comment.