<commit_before>Working Title: D21
=================

[![Code Climate](https://codeclimate.com/github/initiatived21/d21/badges/gpa.svg)](https://codeclimate.com/github/initiatived21/d21) [![Build Status](https://travis-ci.org/initiatived21/d21.svg?branch=develop)](https://travis-ci.org/initiatived21/d21) [![Coverage Status](https://coveralls.io/repos/initiatived21/d21/badge.svg?branch=develop&service=github)](https://coveralls.io/github/initiatived21/d21?branch=develop)



This README would normally document whatever steps are necessary to get the
application up and running.

Things you may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...
<commit_msg>update README to include installation and testing information<commit_after>Working Title: D21
=================

[![Code Climate](https://codeclimate.com/github/initiatived21/d21/badges/gpa.svg)](https://codeclimate.com/github/initiatived21/d21) [![Build Status](https://travis-ci.org/initiatived21/d21.svg?branch=develop)](https://travis-ci.org/initiatived21/d21) [![Coverage Status](https://coveralls.io/repos/initiatived21/d21/badge.svg?branch=develop&service=github)](https://coveralls.io/github/initiatived21/d21?branch=develop)


Installation
------------

You will need ruby version 2.3.0, git, npm, and bundler installed.

`git clone` this repository to your local drive, `cd` into it, and
`bundle install`. Afterwards `npm install` as well.

Then you will also need to `rake db:create` and `rake db:migrate` to get the
database up and running. You can `rake db:seed` to load some initial testing
data.

The rails server is started via `npm run rails-server`

Testing
-------

To run the test suite, simply type in `rake`.
The server-side test suite is located in the `/test/` directory. Most client-
side code can be found in `/client/`, including javascript tests. The JS
test suite is run after a successful run of the server-side test suite, as well
as a couple of additional checks: brakeman, rails-best-practices, and rubocop.

{'fraction_non_alphanumeric': 0.13855970829535097, 'fraction_numerical': 0.02506836827711942, 'mean_word_length': 4.997267759562842, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, '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': '1233091', 'n_tokens_mistral': 719, 'n_tokens_neox': 666, 'n_words': 199}