<commit_before>== README

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

* ...


Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.
<commit_msg>Make readme<commit_after>== README

This a small app with basic apis to look at some data about businesses. 
The app utilizes ruby 2.2.3 and rails 4.2.7

The primary dependency for the app is postgres. If you do not have postgres
installed, you can download it directly from the site or through Homebrew
on a Mac. To get it setup with:

    brew install postgresql

    brew tap homebrew/services

    brew services start postgresql

To get ruby installed, it's recommended to use rvm or rbenv to manage your
ruby version. For rvm, it can be installed with:

    # install rvm
    \curl -sSL https://get.rvm.io | bash -s stable

    rvm install ruby-2.2.3

To get the app up and running, involves intalling all the gems with bundler

    # If bundler is not installed
    gem install bundler

    bundle install

To setup the db

    # creates tables
    rake db:create

    # run migrations
    rake db:migrate

    # import data
    rake data:import

To run tests

    rake test


{'fraction_non_alphanumeric': 0.04909213180901143, 'fraction_numerical': 0.00605245460659045, 'mean_word_length': 3.2033898305084745, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '443853', 'n_tokens_mistral': 442, 'n_tokens_neox': 411, 'n_words': 215}