<commit_before># How to run

## In development

```bash
$ sudo npm install -g grunt-cli
$ npm install
$ grunt serve
```

This is for the first time only, then you'll be good to go with just a `grunt serve`, unless someone updates Node.js dependencies.  
Bower dependencies are automatically taken care of by Grunt thanks to the `wiredep` plugin.

Anyway. It will do its things, run some tests, fire up a local server, then watch for changes (i.e. if you edit a file, it will run proper tasks to update the app. It will also try to refresh your browser if you have a LiveReload extension installed in the browser).

I'm not sure the same applies when you *create* a new file, instead of *editing* one that's already there. Stop and restart grunt, just in case.

URL is [http://localhost:9001](http://localhost:9001).

## In production

Run `grunt dist` and grab the contents of the `dist` directory.

# How to customize

Inside `gui/app/shared/config` you'll find two files:

* `dev.config.json` for the development phase
* `dist.config.json` for the production phase

Use them (carefully and at your own risk) to customize some  bits of the application, notably:

* `ENV.FRONTEND.PAGE_SIZE`: n. of items in paginated lists
* `ENV.BACKEND.URL.HOSTNAME`: just the hostname or IP of the server, used for example to point at the WebSocket server
* `ENV.BACKEND.URL.FULL`: the full base URL of the REST backend, optionally complete with port number and subpath. No trailing slash!

The `dev.` file will be automagically used at every `grunt serve`.  
The `dist.` file will be automagically used at avery `grunt dist`.<commit_msg>Closes #8 - Refine generated app's README<commit_after># How to use this app

This AngularJS application stub was generated using [the angular-trumbitta Yeoman generator](https://github.com/ngTrumbitta/generator-angular-trumbitta), made with <3 by [<NAME> a.k.a. trumbitta](https://github.com/trumbitta).

More details and a fairly complete guide are in the [generator's README](https://github.com/ngTrumbitta/generator-angular-trumbitta/blob/master/README.md).

The following short paragraphs sum up what you need to get started right now if you are in a hurry.

## In development

```bash
$ npm install -g bower grunt-cli
$ npm install # optional, the generator should have run this
$ grunt serve
```

This is for the first time only, then you'll be good to go with just a `grunt serve`, unless you update Node.js dependencies.  
Bower dependencies are automatically taken care of by Grunt thanks to the `wiredep` plugin.

Anyway. It will do its things, run some tests, fire up a local server, then watch for changes (i.e. if you edit a file, it will run proper tasks to update the app. It will also try to refresh your browser if you have a LiveReload extension installed in the browser).

I'm not sure the same applies when you *create* a new file, instead of *editing* one that's already there. Stop and restart grunt, just in case.

URL is [http://localhost:9001](http://localhost:9001).

## In production

Run `grunt dist` and grab the content of the `dist` directory.
{'fraction_non_alphanumeric': 0.0803484995159729, 'fraction_numerical': 0.005808325266214908, 'mean_word_length': 4.2100840336134455, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 4, 'https://': 3, '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': '5610701', 'n_tokens_mistral': 904, 'n_tokens_neox': 863, 'n_words': 456}