<commit_before># doclets

[![Join the chat at https://gitter.im/lipp/doclets](https://badges.gitter.im/lipp/doclets.svg)](https://gitter.im/lipp/doclets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Hosted automated jsdoc API documentation

[![Build Status](https://travis-ci.org/lipp/doclets.svg?branch=master)](https://travis-ci.org/lipp/doclets) [![Coverage Status](https://coveralls.io/repos/lipp/doclets/badge.svg?branch=master&service=github)](https://coveralls.io/github/lipp/doclets?branch=master) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

# Handbag<commit_msg>add some basic info contributing<commit_after># doclets

[![Join the chat at https://gitter.im/lipp/doclets](https://badges.gitter.im/lipp/doclets.svg)](https://gitter.im/lipp/doclets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Hosted automated jsdoc API documentation

[![Build Status](https://travis-ci.org/lipp/doclets.svg?branch=master)](https://travis-ci.org/lipp/doclets) [![Coverage Status](https://coveralls.io/repos/lipp/doclets/badge.svg?branch=master&service=github)](https://coveralls.io/github/lipp/doclets?branch=master) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

# Dev setup

    $ docker-compose -f docker-compose-dev.yml up

## Run tests locally

    $ TEST=1 npm test
  
## Run webserver locally

    $ DEV=1 node bin/server.js
    
Adding users/repos does not work with the local server :(
This is due to GitHub WebHook configuration and GitHub OAuth wich require fix urls.
{'fraction_non_alphanumeric': 0.1642685851318945, 'fraction_numerical': 0.0035971223021582736, 'mean_word_length': 5.784552845528455, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, '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': '3761591', 'n_tokens_mistral': 615, 'n_tokens_neox': 585, 'n_words': 79}