autodata v0.17.0

Autodata

This project is a fork of googleanalytics/autotrack and is part of the ekino github team.

You can find the project documentation at ekino.github.io/autodata

Table of contents

• Requirements
• Getting started
• Setup
  • Installation
  • Setup requirements
• Running autodata
  • Running demo page
  • Running tests
  • Running documentation
• Build autodata
• Release autodata

Requirements

• NodeJS - v8.x.x
• Yarn - v1.x.x

Getting started

Autodata library can be installed with 2 options :

npm

$ npm install autodata

unpkg cdn

<script src="https://unpkg.com/autodata@latest"></script>

All the documentation and examples are available on the project's gitbook : ekino.github.io/autodata

Setup

Installation

• git clone git@github.com:ekino/autodata.git
• yarn

Setup requirements

ENV vars

Create a copy of ENV.json.example and name it ENV.json in order to configure the local environment variable for development.

Running autodata

Every running script of autodata is listed here : demo page, unit tests, documentation

Running demo page

Execute the following command to start autodata demo page

$ yarn start

After what the demo page will be started at this url

• demo page: http://localhost:8080/ - node express

Running tests

Execute the following command to start autodata unit tests

$ yarn test

Running documentation

Only useful if you want to edit documentation, otherwise you can consult online gitbook

Execute the following command to start autodata documentation

$ yarn doc

Build autodata

Execute the following command to build autodata

$ NODE_ENV=(development|production) yarn build

It will create a script depending on NODE_ENV

• NODE_ENV=development -> autodata.js will keep log and unminified code
• NODE_ENV=production -> autodata.min.js will remove log and uglify code

Release autodata

Execute the following command to release autodata

$ yarn version

Choose the new version with yarn interactive mode.