<commit_before><commit_msg>New Readme<commit_after># UK Postcodes

This is the next generation version of [http://www.uk-postcodes.com](http://www.uk-postcodes.com). The functionality is largely unchanged, but improvements include:

* Better codebase (bye bye PHP)
* MongoDB backend
* (Hopefully) better support
* New design
* Easy setup for local installs

## Running a local version

I've included all the necessary data in this repo (which I will keep updated). To get this up and running locally (I'm assuming you have a local instance of MongoDB running, and Ruby installed).

### Clone the repo

  git clone <EMAIL>:theodi/uk-postcodes.git
  
### Run bundler
  
  bundle install
  
### Import the data

  rake import:all

(This will take a good 40 minutes to an hour, so go outside and play, or something)

### Run the app

  rails s
  
Obviously if you're running this in production, you may need to do some other steps, but these steps should be all you need to get it running locally.


{'fraction_non_alphanumeric': 0.07336683417085427, 'fraction_numerical': 0.0020100502512562816, 'mean_word_length': 4.005025125628141, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, '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': '5744338', 'n_tokens_mistral': 287, 'n_tokens_neox': 269, 'n_words': 140}