Skip to content

Latest commit

 

History

History
41 lines (22 loc) · 3.45 KB

README.md

File metadata and controls

41 lines (22 loc) · 3.45 KB


mParticle Web Sample Apps

License

Hello! This is the mParticle Web Sample Apps Repository. We've built a collection of fully functional sample apps that provide a best practice approach to integrate with our mParticle Web SDK and other services we provide.

Getting Started

This repository serves as directory of individual, self-contained, Sample Apps. Each application is a full project with working code, detailed implementation documentation and an integrated CI/CD pipeline via Github Actions.

Our recommenation is to fork or download the entire repository and open a specific project in your IDE or Editor of choice. This will provide full project settings, including NPM tasks and Linting.

ℹ️ Note: These Sample Apps require a mParticle account and a valid Input API key.

While the code might run and build without mParticle credentials, the SDKs will not upload events to our servers and will generate errors. Please visit our docs for more details on setting up an Input API key.

Sample Apps Directory

Below is a list of sample apps, with a brief description of their intended use case. Please navigate to an individual Sample App's README.md file for specific use cases and implementation details.

App Name Demo Path Description
Higgs Shop https://mparticle.github.io/mparticle-web-sample-apps/higgs-shop core-sdk-samples/higgs-shop-sample-app An example of an e-commerce application with simple media interactions

Contributing

Thank you for thinking about contributing to the mParticle Sample Apps Project.

Please review the CONTRIBUTING.md file for details.

Support

[email protected]

License

The mParticle Web SDK is available under the Apache License, Version 2.0. See the LICENSE file for more info.

THE MPARTICLE SAMPLE APPS, INCLUDING ANY ASSOCIATED MPARTICLE APIs AND MPARTICLE SDKs, ARE PROVIDED ON AN “AS-IS” BASIS, AND MPARTICLE HEREBY DISCLAIMS ANY AND ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED (EITHER IN FACT OR BY OPERATION OF LAW), OR STATUTORY, AS TO ANY MATTER WHATSOEVER, INCLUDING, BUT NOT LIMITED TO, ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUALITY, ACCURACY, TITLE, AND NON-INFRINGEMENT. MPARTICLE DOES NOT WARRANT THAT THE MPARTICLE SAMPLE APP, INCLUDING ANY ASSOCIATED, MPARTICLE SDKs OR MPARTICLE APIs, ARE ERROR-FREE OR THAT OPERATION THEREOF WILL BE SECURE OR UNINTERRUPTED.