<commit_before># Pingeon - notification microservice

## About

This project uses [Feathers](http://feathersjs.com). An open source web  framework for building modern real-time applications.

## Getting Started

1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
2. Install your dependencies
    
    ```
    cd path/to/pingeon; npm install
    ```

3. Start your app
    
    ```
    npm start
    ```

## Environment Variables

```
DATABASE_URL
AMQP_URL
PUBSUB_ID
PUBSUB_KEY
EMAIL_KEY
EMAIL_FROM
```

## API<commit_msg>Add AWS SNS env vars to readme (#76)<commit_after># Pingeon - notification microservice

## About

This project uses [Feathers](http://feathersjs.com). An open source web  framework for building modern real-time applications.

## Getting Started

1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
2. Install your dependencies
    
    ```
    cd path/to/pingeon; npm install
    ```

3. Start your app
    
    ```
    npm start
    ```

## Environment Variables

```
DEBUG - All in app logs goes to 'app*'.
PORT - What port server is listening.

AMQP_URL - RabbitMQ url.
DATABASE_URL - db connection url.

PUBSUB_ID - pub/sub provider id.
PUBSUB_KEY - pub/sub provider secret key.

EMAIL_KEY - email provider secret key. 
EMAIL_FROM - for example <EMAIL>

PUSH_KEY - AWS key.
PUSH_SECRET - AWS secret.
PUSH_REGION - AWS SNS region.
PUSH_TITLE - Title for push notifications.
GSM_APP_ARN - Android ARN for AWS SNS.
APNS_APP_ARN - Apple iOS ARN for AWS SNS.
```

## API
{'fraction_non_alphanumeric': 0.10935524652338811, 'fraction_numerical': 0.0050568900126422255, 'mean_word_length': 3.2439678284182305, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, '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': '4343985', 'n_tokens_mistral': 545, 'n_tokens_neox': 520, 'n_words': 173}