<commit_before>This project is based on the [create-react-app template](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md).

## ElasticSearch CORS Setup

This project works with ElasticSearch directly from the Browser. In order for this software to access your ElasticSearch instance, you'll need to configure the ElasticSearch [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) setting to be open.

To do this, first locate your `elasticsearch.yml` file. In Ubuntu Linux, this file is located at `/etc/elasticsearch/elasticsearch.yml`. In this file, add the following lines:

```yml
http.cors.enabled: true
http.cors.allow-origin: "*"
```

This configuration allows any origin to access your ElasticSearch instance, which is fine for development but not recommended for production as it introduces a security vulnerability.

After editing this file, restart ElasticSearch.

`sudo service elasticsearch restart`

## Git Submodules

This project relies on Git submodules. To initialize the project, you'll need to execute the following commands:

```
git submodule init
git submodule update
```

Then every time there is an update to the submodule, you should get the modification using:

```
git submodule update
```

## Installation Procedure

    1. Clone the repository https://github.com/nuagenetworks/visualization-framework
    2. Go inside the `visualization-framework` folder
    3. Initialize the submodule that deals with the configuration `git submodule init`
    4. Update the submodule to get the lastest sources `git submodule update`
    5. Install all dependancies using `npm install` (it will take some time, please be patient)
    6. Run the application using `npm run start` command.

## Settings

Here is a list of environment variable that can be set to configure the visualization framework:

    * `REACT_APP_ELASTICSEARACH_HOST` allows you to specify the Elastic Search server (ex: http://localhost:9200)
    * `REACT_APP_VSD_API_ENDPOINT` allows to specify the VSD API endpoint (ex:https://vsd.com:8443/nuage/api/)
<commit_msg>Updated README file<commit_after>This project is based on the [create-react-app template](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md).

## ElasticSearch CORS Setup

This project works with ElasticSearch directly from the Browser. In order for this software to access your ElasticSearch instance, you'll need to configure the ElasticSearch [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) setting to be open.

To do this, first locate your `elasticsearch.yml` file. In Ubuntu Linux, this file is located at `/etc/elasticsearch/elasticsearch.yml`. In this file, add the following lines:

```yml
http.cors.enabled: true
http.cors.allow-origin: "*"
```

This configuration allows any origin to access your ElasticSearch instance, which is fine for development but not recommended for production as it introduces a security vulnerability.

After editing this file, restart ElasticSearch.

`sudo service elasticsearch restart`

## Installation Procedure

    1. Clone the repository https://github.com/nuagenetworks/visualization-framework
    2. Go inside the `visualization-framework` folder
    3. Install all dependancies using `npm install` (it will take some time, please be patient)
    4. Run the application using `npm run start` command.
    5. Launch tests using `npm run test` command.

## Settings

Here is a list of environment variable that can be set to configure the visualization framework:

    * `REACT_APP_ELASTICSEARACH_HOST` allows you to specify the Elastic Search server (ex: http://localhost:9200)
    * `REACT_APP_VSD_API_ENDPOINT` allows to specify the VSD API endpoint (ex:https://vsd.com:8443/nuage/api/)

{'fraction_non_alphanumeric': 0.07590933052187665, 'fraction_numerical': 0.007116499736425936, 'mean_word_length': 4.698198198198198, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5945578', 'n_tokens_mistral': 1057, 'n_tokens_neox': 1002, 'n_words': 436}