<commit_before># The Faster Scale App 
> An online version of Michael Dye's Faster Relapse Awareness Scale 

[![Build Status](https://travis-ci.org/CorWatts/fasterscale.svg?branch=master)](https://travis-ci.org/CorWatts/fasterscale)
[![codecov](https://codecov.io/gh/CorWatts/fasterscale/branch/master/graph/badge.svg)](https://codecov.io/gh/CorWatts/fasterscale)


## Getting Started
These instructions will help you get a local installation set up for development and testing purposes. See the deployment instructions for how to deploy this to a live system.
### Prerequisites
* PHP >= 7.0
* Composer
* A SASS compiler. We recommend the ```sass``` Ruby Gem. Once rubygems is installed on your machine (if you're on MacOS it already is) you should type ```gem install sass```.
* PostgreSQL 9.1 or later (Theoretically any type of SQL compatible with Yii2's ActiveRecord might work, but we've only tested this on PostgreSQL)

### Installation
* Clone this repo with:  
    ```git clone <EMAIL>:CorWatts/fasterscale.git && cd fasterscale```
* Install necessary dependencies with:  
    ```composer install --dev```
* Execute the init file ```./init --env=Development``` with the environment set to **Development** option
* Edit ```site/config/main-local.php``` and add a cookie validation key in the $config variable
```php
<?php
$config = [ 
  'components' => [
    'request' => [
      'cookieValidationKey' => 'devcookiekey'
    ],
    [...other good stuff...]
  ]
];
```
* Edit ```common/config/main-local.php``` and edit the default database connection information in the $config variable
```php<commit_msg>Updating README<commit_after># The Faster Scale App 
> An online version of Michael Dye's Faster Relapse Awareness Scale 

[![Build Status](https://travis-ci.org/CorWatts/fasterscale.svg?branch=master)](https://travis-ci.org/CorWatts/fasterscale)
[![codecov](https://codecov.io/gh/CorWatts/fasterscale/branch/master/graph/badge.svg)](https://codecov.io/gh/CorWatts/fasterscale)


## Getting Started
These instructions will help you get a local installation set up for development and testing purposes. See the deployment instructions for how to deploy this to a live system.
### Prerequisites
* PHP >= 7.0
* Composer
* A SASS compiler. We recommend the npm project ```node-sass```. Once npm is installed on your machine  type ```npm i node-sass -g```.
* PostgreSQL 9.1 or later (Theoretically any type of SQL compatible with Yii2's ActiveRecord might work, but we've only tested this on PostgreSQL)

### Installation
* Clone this repo with:  
    ```git clone <EMAIL>:CorWatts/fasterscale.git && cd fasterscale```
* Install necessary dependencies with:  
    ```composer install --dev```
* Execute the init file ```./init --env=Development``` with the environment set to **Development** option
* Edit ```site/config/main-local.php``` and add a cookie validation key in the $config variable
```php
<?php
$config = [ 
  'components' => [
    'request' => [
      'cookieValidationKey' => 'devcookiekey'
    ],
    [...other good stuff...]
  ]
];
```
* Edit ```common/config/main-local.php``` and edit the default database connection information in the $config variable
```php
{'fraction_non_alphanumeric': 0.13128140703517588, 'fraction_numerical': 0.00314070351758794, 'mean_word_length': 4.416666666666667, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 15, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4053816', 'n_tokens_mistral': 975, 'n_tokens_neox': 917, 'n_words': 332}