# TrackSoul

**Repository Path**: thinwonton/TrackSoul

## Basic Information

- **Project Name**: TrackSoul
- **Description**: TrackSoul是用于事件跟踪的开源项目，跨平台解决方案。 它支持网站，Web APP，IOS，Android甚至微信上的小程序。改善用户体验的唯一稳定方法是依靠用户行为数据。 无论是决定优化用户界面，营销，销售量，还是预测性分析。  收集数据并不难，要最大程度地提高数据使用效率是我们要关注的重点，我们希望提供从收集到分析的整体解决方案。  我们希望为该项目构建一个长期可维护的生态系统，以扩展用户行为的自由度。这个项目不单止提供收集数据的 Javascript的工具包，更是提供一个完整用户行为分析平台 ！
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/CharlesArea/TrackSoul
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 21
- **Created**: 2021-01-07
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.com/CharlesArea/TrackSoul.svg?token=pxmW9t2DsBfasrmRRuDf&branch=master)](https://travis-ci.com/CharlesArea/TrackSoul)
[![star](https://gitee.com/CharlesArea/TrackSoul/badge/star.svg?theme=dark)](https://gitee.com/CharlesArea/TrackSoul/stargazers)
<p align="center">
  <a href="https://github.com/CharlesArea/TrackSoul//">
    <img width="50%" style="padding-top:0px" src="https://i.ibb.co/Qcp1Rb7/logo-transparent.png">
  </a>
</p>
 
Readme - [中文](https://github.com/CharlesArea/TrackSoul/blob/master/README.CN.md)

TrackSoul is an open-source, cross-platform solution for Event Tracking. It supports Website, Web APP, IOS, Android or even mini-program on WeChat. For more information on using TrackSoul, see the [TrackSoul Website](https://github.com/CharlesArea/TrackSoul/)

##### Codeless Tracking Demo Site- [JsFiddle](https://jsfiddle.net/beatyoup/0dga8L52/7/) (Remember to open console in order to see the effect)

# Table of Contents

* [Description](#Description)
* [Platform architecture](#Platform-architecture)
* [Codeless tracking Usage example screenshots](#Codeless-Usage-demo-screenshots)
	* [Requesting demo screenshot](#Requesting-demo-screenshot-IP-address-hidden)
	* [Click event demo screenshot](#Click-event-demo-screenshot-IP-address-hidden)
	* [Input event demo screenshot](#Input-event-demo-screenshot-IP-address-hidden)
* [Specific tracking path Usage demo example](#Specific-tracking-Usage-demo-example)
* [SDK Config](#SDK-Config)
* [Module bundler](#Module-bundler)
* [SDK script usage](#SDK-script-usage)
* [SDK Releases](#SDK-Releases)
* [Application analysis panel](#Application-analysis-panel)
	* [Adding a tracking point](#Adding-a-tracking-point)

## Description

This is a user behavior Javascript SDK planned to support Website, Web APP, WeChat mini-program, and Native APP Both Android and IOS in the coming future.

The only stable method to improve your user experience for your audience is to rely on user behavior data. No matter deciding on enhancing user interface, marketing, make sales, and even predictive analytics. 

Collecting data is not hard, to maximum the efficiency of the data usage is what we wanted to focus on, we wanted to provide a total solution from collecting to analysing.

We wanted to build a long-going maintainable ecosystem for this project to spread out for the freedom of user behavior.

## Platform architecture

<p align="center">
  <a href="https://github.com/CharlesArea/TrackSoul//">
    <img style="padding-top:0px" src="https://i.ibb.co/1nYMzyF/Diagram.png">
  </a>
</p>

## Codeless Usage demo screenshots
#### Requesting demo screenshot (IP address hidden)
<p align="center">
  <a href="https://jsfiddle.net/beatyoup/0dga8L52/7/">
    <img style="padding-top:0px" src="https://github.com/CharlesArea/TrackSoul/blob/master/tracking_demo/screenshots/client_requesting.png?raw=true">
  </a>
</p>

#### Click event demo screenshot (IP address hidden)
<p align="center">
  <a href="https://jsfiddle.net/beatyoup/0dga8L52/7/">
    <img style="padding-top:0px" src="https://github.com/CharlesArea/TrackSoul/blob/master/tracking_demo/screenshots/client_clicking.png?raw=true">
  </a>
</p>

#### Input event demo screenshot (IP address hidden)
<p align="center">
  <a href="https://jsfiddle.net/beatyoup/0dga8L52/7/">
    <img style="padding-top:0px" src="https://github.com/CharlesArea/TrackSoul/blob/master/tracking_demo/screenshots/client_typing.png?raw=true">
  </a>
</p>
<br>

## Specific tracking Usage demo example

```js
specific_tracking(Config.script_domain, Config.specific_tracking, 'http://localhost:3000/index.html', '/html[1]/body[1]/h1[3]', 'Test Specifc path');

```

## SDK Config
| Name | Type | Example | Description|
|--|--|--|--|
| sdk_name | string | TrackSoul | Our Javascript SDK name |
| data_endpoint | string | https://tracksoul.com/tracking/data | Set the endpoint where the tracking data send to |
| input_tracking | boolean | true | Enable / Disable tracking input data |
| behaviour_tracking | boolean | true | Enable / Disable tracking click data |

## Module bundler
I have chosen [Roll.js](https://github.com/rollup/rollup) and had fall in love ♥ with it
Simple just install via npm and run the script below in your terminal / cmd
```bash
# installing rollup
npm install --global rollup
```
```bash
# compile to a <script> containing a self-executing function
rollup -c
```

## SDK script usage
Point to an external/internal JavaScript file like below
```html
<html>
    <head>
    <!-- Link our Tracksoul dist javascript sdk like below --> 
    <script src="tracksoul-0.0.1.min.js"></script>
    </head>

    <body></body>
</html>
```
## SDK Releases

Coming soon

## Application analysis panel
#### Adding a tracking point
<p align="center">
  <a href="https://github.com/CharlesArea/TrackSoul//">
    <img style="padding-top:0px" src="https://i.ibb.co/Q9sVs1F/Screenshot-2020-07-03-at-10-31-21-AM.png">
  </a>
</p>