<commit_before>capstone2014-firefoxOS
======================

Javascript APIs for offline communications in Firefox OS. PSU CS Capstone 2014

Framework Setup
======================

**Node.js**
Download nodeJS (http://nodejs.org/)
Open up the Node.js Command Prompt
Navigate to your local firefox-OS repo

Run the following commands

````npm install````

````grunt build````

The build task will recompile the library and run the tests. If you've updated the test and only need to rerun them:
````grunt test````

You'll see a bunch of tests get run and pass.

**NetBeans**
Download NetBeans from https://netbeans.org/downloads/
Open NetBeans, create a "New Project", then select "HTML5 Application with Existing Sources"
The "lib" folder will hold our API prototypes
The "test/spec" folder will hold our tests files

Development Practices
=====================

Currently, we are using nodeJs (JavaScript on the command line) along
with grunt (a node task runner). These combined with bower (a
dependency manager) and Karma (unit testing) allow for a pretty good
combination for testing and developing code.

Clone the repo and cd to it, then run (preface any install commands with sudo if running on linux):

````npm install````

````npm install -g grunt-cli````

````grunt build````<commit_msg>update readme with framework setup<commit_after>capstone2014-firefoxOS
======================

Javascript APIs for offline communications in Firefox OS. PSU CS Capstone 2014

Framework Setup
======================

**Node.js**
Download nodeJS (http://nodejs.org/)  
Open up the Node.js Command Prompt  
Navigate to your local firefox-OS repo  

Run the following commands  

````npm install````

````grunt build````

The build task will recompile the library and run the tests. If you've updated the test and only need to rerun them:
````grunt test````

You'll see a bunch of tests get run and pass.  

**NetBeans**  
Download NetBeans from https://netbeans.org/downloads/  
Open NetBeans, create a "New Project", then select "HTML5 Application with Existing Sources"  
The "lib" folder will hold our API prototypes  
The "test/spec" folder will hold our tests files  

Development Practices
=====================

Currently, we are using nodeJs (JavaScript on the command line) along
with grunt (a node task runner). These combined with bower (a
dependency manager) and Karma (unit testing) allow for a pretty good
combination for testing and developing code.

Clone the repo and cd to it, then run (preface any install commands with sudo if running on linux):

````npm install````

````npm install -g grunt-cli````

````grunt build````
{'fraction_non_alphanumeric': 0.13292821876186858, 'fraction_numerical': 0.006836308393467528, 'mean_word_length': 4.840354767184036, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '694584', 'n_tokens_mistral': 778, 'n_tokens_neox': 687, 'n_words': 353}