<commit_before># cling

[![Build Status](https://travis-ci.org/delasteve/cling.svg?branch=master)](https://travis-ci.org/delasteve/cling)
[![dependencies Status](https://david-dm.org/delasteve/cling/status.svg)](https://david-dm.org/delasteve/cling)
[![devDependencies Status](https://david-dm.org/delasteve/cling/dev-status.svg)](https://david-dm.org/delasteve/cling?type=dev)

A SlackBot for the Angular CLI team.

## Installation

```
git clone <EMAIL>:delasteve/cling.git
cd cling
npm install
```

## Configuration

In order for this project to run you need a Firebase service account file, a GitHub token, and a Slack token.

### Environment File

- Copy the `.env.example` file so you can edit the appropriate environment variables

  ```sh
  cp .env.example .env
  ```

**N.B.** Do not use quotes for any environment variables

### Firebase

- Log in to the [Firebase](https://firebase.google.com) console.
- Create New Project or open an existing one.
- Click the cog icon and select Project Settings.
- Click on Service Accounts and click the `Generate new Private Key` button. This will download a `json` file.
- Set the `FIREBASE_*` environment variables in the `.env` file with the appropriate values from the `json` file

### Slack

- Login to your Slack admin: https://your-team-name.slack.com/admin
- Click `Configure Apps` in the sidebar
- Search for `Bots` and on the bot page click `Add Configuration`
- Give the bot a name and click `Add bot integration`
- Set the `SLACK_TOKEN` environment variable with the bot token, e.g. `<KEY>`

### GitHub

- Login to your GitHub account: https://github.com/login
- Navigate to https://github.com/settings/tokens/new
- Fill in the token description
- Select the `repo` checkbox
- Click `Generate Token` at the bottom of the page
- Set the `GITHUB_TOKEN` variable with the generated
- Set the `GITHUB_PROJECT` variable with the project you would like to have the bot work with
  e.g. `angular/angular-cli`

## License

MIT
<commit_msg>chore(readme): fix line break<commit_after># cling

[![Build Status](https://travis-ci.org/delasteve/cling.svg?branch=master)](https://travis-ci.org/delasteve/cling)
[![dependencies Status](https://david-dm.org/delasteve/cling/status.svg)](https://david-dm.org/delasteve/cling)
[![devDependencies Status](https://david-dm.org/delasteve/cling/dev-status.svg)](https://david-dm.org/delasteve/cling?type=dev)

A SlackBot for the Angular CLI team.

## Installation

```
git clone <EMAIL>:delasteve/cling.git
cd cling
npm install
```

## Configuration

In order for this project to run you need a Firebase service account file, a GitHub token, and a Slack token.

### Environment File

- Copy the `.env.example` file so you can edit the appropriate environment variables

  ```sh
  cp .env.example .env
  ```

**N.B.** Do not use quotes for any environment variables

### Firebase

- Log in to the [Firebase](https://firebase.google.com) console.
- Create New Project or open an existing one.
- Click the cog icon and select Project Settings.
- Click on Service Accounts and click the `Generate new Private Key` button. This will download a `json` file.
- Set the `FIREBASE_*` environment variables in the `.env` file with the appropriate values from the `json` file

### Slack

- Login to your Slack admin: https://your-team-name.slack.com/admin
- Click `Configure Apps` in the sidebar
- Search for `Bots` and on the bot page click `Add Configuration`
- Give the bot a name and click `Add bot integration`
- Set the `SLACK_TOKEN` environment variable with the bot token, e.g. `xox*-************-************************`

### GitHub

- Login to your GitHub account: https://github.com/login
- Navigate to https://github.com/settings/tokens/new
- Fill in the token description
- Select the `repo` checkbox
- Click `Generate Token` at the bottom of the page
- Set the `GITHUB_TOKEN` variable with the generated
- Set the `GITHUB_PROJECT` variable with the project you would like to have the bot work with

  e.g. `angular/angular-cli`

## License

MIT

{'fraction_non_alphanumeric': 0.12481426448736999, 'fraction_numerical': 0.0, 'mean_word_length': 4.158365261813538, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 20, 'lorem ipsum': 0, 'www.': 0, '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': '2158755', 'n_tokens_mistral': 1264, 'n_tokens_neox': 1217, 'n_words': 463}