<commit_before># ubirch Admin UI

## General Information

ubrich user interface to manage and monitor IOT devices

## Quick Start

0. start ubirch-avatar-service at localhost:8080 (default)
1. `npm install`
2. `bower install`
3. `grunt serve
4. Open http://localhost:9000

## API Documentation

The documentation of the underlying API can be found [here](http://developer.ubirch.com/docs/api)

## Dependencies

We expect the following tools been installed on the machine:

* [npm, package manager for JavaScript](https://www.npmjs.com) (used for nodejs components)

* [bower, package manager](http://gruntjs.com) (used for angular components)
  
        npm install -g bower

* [grunt, the build tool](http://gruntjs.com)

        npm install -g grunt-cli

## Build & development

### Run locally

If you want to run the latest code from git, here's how to get started:

0. checkout and follow the instructions of the ubirch-avatar-service

        git clone https://github.com/ubirch/ubirch-avatar-service

1. Clone the code:

        git clone https://github.com/ubirch/ubirch-admin-ui
        cd ubirch-admin-ui

2. Install the project dependencies

        npm install

3. Install the used angular modules

        bower install

4. Start backend on localhost:8080

5. Build and run the code

        grunt serve

6. Open in Browser:

        http://localhost:9000

### Run tests

Running `grunt test` will run the unit tests with karma.

### Deployment

If you want to deploy the latest version on a server, follow these instructions:

1. Clone the code:

        git clone https://github.com/ubirch/ubirch-admin-ui
        cd ubirch-admin-ui

2. Server settings

  change the settings, especially in one of the following files:
   
  *  settings/settings_dev.js
  *  settings/settings_int.js
  *  settings/settings_prod.js
  
  especially change 
  
  * the url of the backend server in UBIRCH_API_HOST
  * specify DEFAULT_DEVICE_TYPE_KEY if it doesn't equal to 'unknownDeviceTypeKey'
  
3. Run deployment script

For prod deployment execute

        ./deployWeb.sh
<commit_msg>ReadMe: Installation of dependant tools<commit_after># ubirch Admin UI

## General Information

ubrich user interface to manage and monitor IOT devices

## Quick Start

0. start ubirch-avatar-service at localhost:8080 (default)
1. `npm install`
2. `bower install`
3. `grunt serve
4. Open http://localhost:9000

## API Documentation

The documentation of the underlying API can be found [here](http://developer.ubirch.com/docs/api)

## Dependencies

We expect the following tools been installed on the machine:

* Node.js and
* [npm, package manager for JavaScript](https://www.npmjs.com) (used for nodejs components)

npm is bundled with node

Download and install Node.js from the following download page:

https://nodejs.org/en/download/

For Unix you can all

        curl -L https://www.npmjs.com/install.sh | sh


* [bower, package manager](http://gruntjs.com) (used for angular components)
  
        npm install -g bower

* [grunt, the build tool](http://gruntjs.com)

        npm install -g grunt-cli

## Build & development

### Run locally

If you want to run the latest code from git, here's how to get started:

0. checkout and follow the instructions of the ubirch-avatar-service

        git clone https://github.com/ubirch/ubirch-avatar-service

1. Clone the code:

    (deposit your PubKey at gitHub) 

        git clone <EMAIL>:ubirch/ubirch-admin-ui.git
        cd ubirch-admin-ui

2. Install the project dependencies

        npm install

3. Install the used angular modules

        bower install

4. Start backend

See instructions in BE components

5. Build and run the code on localhost:9000

        grunt serve

6. Open in Browser:

        http://localhost:9000

### Deployment

If you want to deploy the latest version on a server, follow these instructions:

1. Clone the code:

        git clone https://github.com/ubirch/ubirch-admin-ui
        cd ubirch-admin-ui

2. Server settings

  change the settings, especially in one of the following files:
   
  *  settings/settings_dev.js
  *  settings/settings_int.js
  *  settings/settings_prod.js
  
  especially change 
  
  * the url of the backend server in UBIRCH_API_HOST
  * specify DEFAULT_DEVICE_TYPE_KEY if it doesn't equal to 'unknownDeviceTypeKey'
  
3. Run deployment script

For prod deployment execute

        ./deployWeb.sh

{'fraction_non_alphanumeric': 0.07996365288505225, 'fraction_numerical': 0.014084507042253521, 'mean_word_length': 3.1537735849056605, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 9, 'lorem ipsum': 0, 'www.': 3, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1234484', 'n_tokens_mistral': 1393, 'n_tokens_neox': 1309, 'n_words': 504}