<commit_before>Camomile Annotation REST API
============================

Requirements
------------

  * node.js
  * npm
  * mongodb

Install
-------

  $ npm install

Run
---

  $ mongod
  $ node app.js<commit_msg>docs: heroku instruction<commit_after># Camomile Annotation REST API

## Heroku setup

1. Follow [Heroku quickstart guide](https://devcenter.heroku.com/articles/quickstart)
2. Deploy camomile-server:

```bash
$ git clone https://github.com/camomile-project/camomile-server.git  
$ cd camomile-server  
$ heroku create  
$ heroku addons:add mongolab  
$ git push heroku master
``` 

## Local setup

1. Install requirements
    - node.js and npm
    - mongodb  

2. Get source code and install node modules:

```bash
$ git clone https://github.com/camomile-project/camomile-server.git  
$ cd camomile-server  
$ npm install  
```

3. Run:

```bash
$ mongod 
$ node app.js  
```
{'fraction_non_alphanumeric': 0.16067415730337078, 'fraction_numerical': 0.0056179775280898875, 'mean_word_length': 3.1059907834101383, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, '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': '6141151', 'n_tokens_mistral': 322, 'n_tokens_neox': 299, 'n_words': 77}