<commit_before>Rails engine for ![rearview](http://github.com/livingsocial/rearview). This project is for rearview developers only. For users please go to ![rearview](http://github.com/livingsocial/rearview) project for installation, configuration, and other details.

# Development Guide

Before developing please read how to ![contribute](https://github.com/livingsocial/rearview-engine/blob/master/CONTRIBUTING.md).

## Intro

Before contributing you should read ![Getting Started with Engine](http://guides.rubyonrails.org/engines.html) guide to familiarize yourself with rails engines.

Rearview consists of two components:

(1) Rearview engine (this repo)

The vast majority of any code customizations and bug fixes should be made here. 

(2) Rearview engine host (https://github.com/livingsocial/rearview)

This is mostly a convienience for users so they can quickly get rearview up and running. This also allows users to customize views and other components at well defined extension points without them having to submit them back into the code base.

**Note: the rearview engine is not completely isolated (yet) so it cannot be safely multi-tennated with other engines in the same host**

## Getting started

#### clone the rearview engine

    git clone git@github.com:livingsocial/rearview-engine.git

#### clone the rearview engine host

    git clone git@github.com:livingsocial/rearview.git
    
#### edit the engine host Gemfile to point to your local engine clone

Change the line simliar to this

    gem 'rearview', '~> 1.0.0'
    
To point to the path you cloned the engine too, for example

    gem 'rearview', :path => '~/clone/path/rearview-engine'

#### sync the engine host database

    rake rearview:install:migrations
    rake db:setup
    
#### start the engine host server

    bin/rails server
    
## User Interface Guide

Rearview does not use the asset pipeline. Instead you'll need to take a look at ![public/rearview-src](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview-src). In development mode javascript, css, etc is loaded directly from here. When rearview-engine is bundled as a Gem the various elements are pre-compiled (manually before **gem build**) using require and are loaded from ![public/rearview](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview).

To compile the ui before distribution, run the following rake task from inside rearview-engine:

    rake rearview:ui:build






    
<commit_msg>fixed links<commit_after>Rails engine for [rearview](http://github.com/livingsocial/rearview). This project is for rearview developers only. For users please go to [rearview](http://github.com/livingsocial/rearview) project for installation, configuration, and other details.

# Development Guide

Before developing please read how to [contribute](https://github.com/livingsocial/rearview-engine/blob/master/CONTRIBUTING.md).

## Intro

Before contributing you should read [Getting Started with Engine](http://guides.rubyonrails.org/engines.html) guide to familiarize yourself with rails engines.

Rearview consists of two components:

(1) Rearview engine (this repo)

The vast majority of any code customizations and bug fixes should be made here. 

(2) Rearview engine host (https://github.com/livingsocial/rearview)

This is mostly a convienience for users so they can quickly get rearview up and running. This also allows users to customize views and other components at well defined extension points without them having to submit them back into the code base.

**Note: the rearview engine is not completely isolated (yet) so it cannot be safely multi-tennated with other engines in the same host**

## Getting started

#### clone the rearview engine

    git clone <EMAIL>:livingsocial/rearview-engine.git

#### clone the rearview engine host

    git clone <EMAIL>:livingsocial/rearview.git
    
#### edit the engine host Gemfile to point to your local engine clone

Change the line simliar to this

    gem 'rearview', '~> 1.0.0'
    
To point to the path you cloned the engine too, for example

    gem 'rearview', :path => '~/clone/path/rearview-engine'

#### sync the engine host database

    rake rearview:install:migrations
    rake db:setup
    
#### start the engine host server

    bin/rails server
    
## User Interface Guide

Rearview does not use the asset pipeline. Instead you'll need to take a look at [public/rearview-src](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview-src). In development mode javascript, css, etc is loaded directly from here. When rearview-engine is bundled as a Gem the various elements are pre-compiled (manually before **gem build**) using require and are loaded from [public/rearview](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview).

To compile the ui before distribution, run the following rake task from inside rearview-engine:

    rake rearview:ui:build






    

{'fraction_non_alphanumeric': 0.08196062675773402, 'fraction_numerical': 0.002008838891120932, 'mean_word_length': 4.342274678111588, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6140154', 'n_tokens_mistral': 1416, 'n_tokens_neox': 1337, 'n_words': 567}