<commit_before>[![Stories in Ready](https://badge.waffle.io/open-app/cobudget-ui.png?label=ready&title=Ready)](https://waffle.io/open-app/cobudget-ui)
# Cobudget! user interface

[![Build Status](https://travis-ci.org/open-app/cobudget-ui.svg?branch=master)](https://travis-ci.org/open-app/cobudget-ui)
[![Code Climate](https://codeclimate.com/github/open-app/cobudget-ui/badges/gpa.svg)](https://codeclimate.com/github/open-app/cobudget-ui)

Cobudget is a web app helping people collaborate on budgets. For more about the project as a whole, check out the [top-level repo](https://github.com/open-app/cobudget). This repo is the user interface component.

## [CONTRIBUTING](./CONTRIBUTING.md)

## [STACK](./STACK.md)

## How to...

### Install

Install node and npm: https://github.com/joyent/node/wiki/Installation 

```
git clone https://github.com/open-app/cobudget-ui
cd cobudget-ui
npm install
```

### Configure

To configure `production` and other environments, copy `config/development.coffee` to `config/production.coffee` and change properties as appropriate. If you need to access other environment variables, use `process.env.VAR_NAME`, as the config is simply coffeescript.

### Run

*Build on watch and start livereload server:*

```
npm run develop
```

*Build once and start static server:*

```
npm start
```

### Deploy

*Stage (push to gh-pages)*

```
NODE_ENV=production npm run stage
```

*Deploy (push to dokku)*

```
git remote add deploy dokku@next.cobudget.co:app
```

```
NODE_ENV=production npm run deploy
```

### Test

To setup e2e (integration) tests, in another terminal run `npm run webdriver-update` to install Selenium and `npm run webdriver-start` to start the Selenium serer. The UI server must be running (`npm run develop` or `npm start`)while performing e2e tests.<commit_msg>update deploy docs<commit_after>[![Stories in Ready](https://badge.waffle.io/open-app/cobudget-ui.png?label=ready&title=Ready)](https://waffle.io/open-app/cobudget-ui)
# Cobudget! user interface

[![Build Status](https://travis-ci.org/open-app/cobudget-ui.svg?branch=master)](https://travis-ci.org/open-app/cobudget-ui)
[![Code Climate](https://codeclimate.com/github/open-app/cobudget-ui/badges/gpa.svg)](https://codeclimate.com/github/open-app/cobudget-ui)

Cobudget is a web app helping people collaborate on budgets. For more about the project as a whole, check out the [top-level repo](https://github.com/open-app/cobudget). This repo is the user interface component.

## [CONTRIBUTING](./CONTRIBUTING.md)

## [STACK](./STACK.md)

## How to...

### Install

Install node and npm: https://github.com/joyent/node/wiki/Installation 

```
git clone https://github.com/open-app/cobudget-ui
cd cobudget-ui
npm install
```

### Configure

To configure `production` and other environments, copy `config/development.coffee` to `config/production.coffee` and change properties as appropriate. If you need to access other environment variables, use `process.env.VAR_NAME`, as the config is simply coffeescript.

### Run

*Build on watch and start livereload server:*

```
npm run develop
```

*Build once and start static server:*

```
npm start
```

### Deploy

*Stage (push to gh-pages)*

```
NODE_ENV=production npm run stage
```

*Deploy (push to heroku)*

```
npm run set-remote
npm run set-buildpack
```

```
npm run deploy
```

### Test

To setup e2e (integration) tests, in another terminal run `npm run webdriver-update` to install Selenium and `npm run webdriver-start` to start the Selenium serer. The UI server must be running (`npm run develop` or `npm start`)while performing e2e tests.
{'fraction_non_alphanumeric': 0.14376731301939058, 'fraction_numerical': 0.00110803324099723, 'mean_word_length': 4.704581358609794, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 1, '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': '6042473', 'n_tokens_mistral': 1267, 'n_tokens_neox': 1187, 'n_words': 341}