65 lines
2.9 KiB
Markdown
65 lines
2.9 KiB
Markdown
# smartanalytics
|
|
|
|
Google Analytics everywhere
|
|
|
|
## Availabililty
|
|
|
|
[](https://www.npmjs.com/package/smartanalytics)
|
|
[](https://GitLab.com/pushrocks/smartanalytics)
|
|
[](https://github.com/pushrocks/smartanalytics)
|
|
[](https://pushrocks.gitlab.io/smartanalytics/)
|
|
|
|
## Status for master
|
|
|
|
[](https://GitLab.com/pushrocks/smartanalytics/commits/master)
|
|
[](https://GitLab.com/pushrocks/smartanalytics/commits/master)
|
|
[](https://www.npmjs.com/package/smartanalytics)
|
|
[](https://david-dm.org/pushrocks/smartanalytics)
|
|
[](https://www.bithound.io/github/pushrocks/smartanalytics/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/smartanalytics)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
### Why does this package exist?
|
|
|
|
Tracking users in webapps is common, often to gain insight in who is using what and where to spend dev resources for best efficiency.
|
|
|
|
Doing the same stuff in apps can be a bit of a hassle.
|
|
Unnecessary dependencies used by many existing analytics tools make the whole app slow
|
|
just to gain a little usage info.
|
|
|
|
**Say hello to smartanalytics. :)**
|
|
It features a very slim dependency tree using the native node request module to send posts to a tracking API of your choice.
|
|
|
|
### How do I use this package?
|
|
|
|
```javascript
|
|
import { Analytics } from 'smartanalytics';
|
|
let myAnalytics = new plugins.smartanalytics.Analytics({
|
|
apiEndPoint: 'https://somepubapi.endpoint.com',
|
|
projectId: 'gitzone',
|
|
appName: 'npmts'
|
|
});
|
|
|
|
myAnalytics
|
|
.recordEvent('someEvent', {
|
|
myKey1: 'myValue1',
|
|
myKey2: 'myValue2',
|
|
myDataKey3: 3
|
|
})
|
|
.catch(err => {
|
|
console.log(err);
|
|
});
|
|
```
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
[](https://push.rocks)
|