<commit_before># Kaltura Analytics 2.0 Front-End (aka kAnalony project Front-End) 
This project is the new client analytics project of Kaltura. 

With kAnalony project, Kaltura real time analytics for live and on-demand video, you'll get historical or near real-time, raw or summarized data Kaltura partners need to truly understand how, when, and where their content is seen and shared by viewers. What keeps viewers watching? When do they lose interest? What do they share? Actionable Analytics ends the guesswork. 

With the clear numbers in hand, Kaltura’s partner can build a content and monetization strategy that really works.

> To make it work with real data, you will need to setup the [server analytics project](https://github.com/kaltura/kanalony).  

## Getting Started

To run kAnalony project on your machine,first make sure you setup your machine correctly.

> Before continuing make sure you have [node.js](https://nodejs.org/en/) installed on your machine.

Install both bower and grunt-cli globally (note the -g flag)

```bash
$ npm install -g bower grunt-cli 
```

In the repository folder install node modules
```
$ npm install 
```

Make sure bower libraries are installed
```
$ bower install
```

You also required to have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Sass](http://sass-lang.com/install) installed. If you're on OS X or Linux you probably already have Ruby installed; test with the following command in your terminal. 

```
$ ruby -v
```
 
When you've confirmed you have Ruby installed, continue installing the Sass engine.

 ``` 
 $ gem install sass
 ```


**You are ready!** to open the application in the browser continue reading section '[usage section](##usage)'.

## Usage
This project is using grunt to run develop & packaging tasks.
 
 > Make sure you [setup your machine](##getting-started) before continuing.

To start working on the project, use the 'serve' grunt task as followed:

```
$ grunt serve
```

This command will browserify your project and open a browser with your site. Whenever you change an html of javascript file the site will be loaded automatically.

If you get any errors during the process just follow the [FAQ](##faq) section.

## Demo (local) server
kAnalony front-end application uses a demo server to simulate front-end scenarios. In order to run the demo (local) server, open the server folder ```$ cd server``` and install node modules.

```
$ npm install
```

Now you should be able to run the demo server at port 9911 using the following command

```
$ grunt
```

To make sure it works, just run the following url in your browser *'http://localhost:9911/yo'* and excect the following result:

```
{"name":"kAnalony demo (local) server","version":"v3"}
```



## Technical information
kAnalony application is based on many third party libraries. You can review the full list in the wiki (TBD). 

## FAQ

**Why am I getting jshint errors when running grunt tasks?**

Every grant task runs checks against the javascript files to make sure there aren't any syntax issues. 
There is no way to bypass them, you should fix them in order to continue. 
That being said, you can use the _--force_ flag to temoprary force the process to continue but I strongly advice you not doing so because it might affect other failures.



# License and Copyright Information
All code in this project is released under the [AGPLv3 license](http://www.gnu.org/licenses/agpl-3.0.html) unless a different license for a particular library is specified in the applicable library path.   

Copyright © Kaltura Inc. All rights reserved.   
Authors and contributors: See [GitHub contributors list](https://github.com/kaltura/kanalony-front-end/graphs/contributors).  

### Open Source Libraries
Review the [list of Open Source 3rd party libraries](open-source-libraries.md) used in this project.
<commit_msg>reflrecting the packaging process in readme.md<commit_after># Kaltura Analytics 2.0 Front-End (aka kAnalony project Front-End) 
This project is the new client analytics project of Kaltura. 

With kAnalony project, Kaltura real time analytics for live and on-demand video, you'll get historical or near real-time, raw or summarized data Kaltura partners need to truly understand how, when, and where their content is seen and shared by viewers. What keeps viewers watching? When do they lose interest? What do they share? Actionable Analytics ends the guesswork. 

With the clear numbers in hand, Kaltura’s partner can build a content and monetization strategy that really works.

> To make it work with real data, you will need to setup the [server analytics project](https://github.com/kaltura/kanalony).  

## Getting Started

To run kAnalony project on your machine,first make sure you setup your machine correctly.

> Before continuing make sure you have [node.js](https://nodejs.org/en/) installed on your machine.

Install both bower and grunt-cli globally (note the -g flag)

```bash
$ npm install -g bower grunt-cli 
```

In the repository folder install node modules
```
$ npm install 
```

Make sure bower libraries are installed
```
$ bower install
```

You also required to have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Sass](http://sass-lang.com/install) installed. If you're on OS X or Linux you probably already have Ruby installed; test with the following command in your terminal. 

```
$ ruby -v
```
 
When you've confirmed you have Ruby installed, continue installing the Sass engine.

 ``` 
 $ gem install sass
 ```


**You are ready!** to open the application in the browser continue reading section '[usage section](##usage)'.

## Usage
This project is using grunt to run develop & packaging tasks.
 
 > Make sure you [setup your machine](##getting-started) before continuing.

To start working on the project, use the 'serve' grunt task as followed:

```
$ grunt serve
```

This command will browserify your project and open a browser with your site. Whenever you change an html of javascript file the site will be loaded automatically.

If you get any errors during the process just follow the [FAQ](##faq) section.

### Packaging the application for deployment
When you are ready to deploy your application run one of the following.

To build the project and create a zip file run the following command.

```
$ grunt build:prod 
```
You will then have:

- folder **'dist'** will include the deployed application
- folder **'.tmp'** will include a zip file ready for deployment

If you want to test your packaged application in a browser first run the following command:

```
$ grunt serve:prod
```


## Demo (local) server
kAnalony front-end application uses a demo server to simulate front-end scenarios. In order to run the demo (local) server, open the server folder ```$ cd server``` and install node modules.

```
$ npm install
```

Now you should be able to run the demo server at port 9911 using the following command

```
$ grunt
```

To make sure it works, just run the following url in your browser *'http://localhost:9911/yo'* and excect the following result:

```
{"name":"kAnalony demo (local) server","version":"v3"}
```



## Technical information
kAnalony application is based on many third party libraries. You can review the full list in the wiki (TBD). 

## FAQ

**Why am I getting jshint errors when running grunt tasks?**

Every grant task runs checks against the javascript files to make sure there aren't any syntax issues. 
There is no way to bypass them, you should fix them in order to continue. 
That being said, you can use the _--force_ flag to temoprary force the process to continue but I strongly advice you not doing so because it might affect other failures.



# License and Copyright Information
All code in this project is released under the [AGPLv3 license](http://www.gnu.org/licenses/agpl-3.0.html) unless a different license for a particular library is specified in the applicable library path.   

Copyright © Kaltura Inc. All rights reserved.   
Authors and contributors: See [GitHub contributors list](https://github.com/kaltura/kanalony-front-end/graphs/contributors).  

### Open Source Libraries
Review the [list of Open Source 3rd party libraries](open-source-libraries.md) used in this project.

{'fraction_non_alphanumeric': 0.07895694360218314, 'fraction_numerical': 0.0036385688295936932, 'mean_word_length': 4.289288005131494, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4679741', 'n_tokens_mistral': 2280, 'n_tokens_neox': 2133, 'n_words': 1149}