/countly-sdk-web

Countly SDK for Web

Primary LanguageJavaScriptMIT LicenseMIT

Countly Web SDK

Build Status npm version Bower version Inline docs

What's Countly?

Countly is an innovative, real-time, open source mobile analytics application. It collects data from mobile devices, and visualizes this information to analyze mobile application usage and end-user behavior. There are two parts of Countly: the server that collects and analyzes data, and mobile SDK that sends this data. Both parts are open source with different licensing terms.

This repository includes the Countly Web SDK. For more information about this SDK, Countly SDK for Web integration guide at Countly Resources or Countly Web SDK Documentation

Implementing Countly SDK in your web pages

There are 3 ways to get Countly SDK.

1. Available with Countly server

Since Countly server 16.02, Countly Web SDK is available in your Countly server installation in countly/frontend/express/public/sdk/web/countly.min.js which should be available through URL as http://yourserver.com/sdk/web/countly.min.js

2. Installation using package managers

bower install countly-sdk-web

or

npm install countly-sdk-web

or

yarn add countly-sdk-web

3. Use a CDN (content delivery network)

Countly web SDK is available on CDNJS. Use either

https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/16.12.1/countly.min.js

or

https://cdn.jsdelivr.net/countly-sdk-web/latest/countly.min.js

How to use Countly Web SDK?

Link to the script and call helper methods based on what you want to track: sessions, views, clicks, custom events, user data, etc. More information is available at http://resources.count.ly/docs/countly-sdk-for-web

Using Countly web SDK in your web page

Countly Web SDK has JSDoc3 compatible comments and you can generate documentation by running npm run-script docs or access online version at http://countly.github.io/countly-sdk-web/

Other Github resources

Check Countly Community Edition source code here:

There are also other Countly SDK repositories below:

How can I help you with your efforts?

Glad you asked. We need ideas, feedbacks and constructive comments. All your suggestions will be taken care with upmost importance. We are on Twitter and Facebook if you would like to keep up with our fast progress!

If you like Countly, why not use one of our badges and give a link back to us, so others know about this wonderful platform?

Light badge Dark badge

Support

For a public community support page, visit http://community.count.ly.

NPM