<commit_before>Wenge
=====

[![Circle CI](https://circleci.com/gh/IMA-WorldHealth/wenge.svg?style=shield)](https://circleci.com/gh/IMA-WorldHealth/wenge)
[![Dependency Status](https://david-dm.org/IMA-WorldHealth/wenge.svg)](https://david-dm.org/IMA-WorldHealth/wenge)
[![devDependency Status](https://david-dm.org/IMA-WorldHealth/wenge/dev-status.svg)](https://david-dm.org/IMA-WorldHealth/wenge#info=devDependencies)
[![bitHound Overall Score](https://www.bithound.io/github/IMA-WorldHealth/wenge/badges/score.svg)](https://www.bithound.io/github/IMA-WorldHealth/wenge)


Wenge is a web application for creating, reviewing, and approving Authorizations for Expenditure (AFEs).
This is an experimental application written to transition the IMA World Health office in
Kinshasa to a paperless AFE system.

### Installation

You need [nodejs](https://nodejs.org) and [sqlite3](https://www.sqlite.org/).  To install, use npm.
```sh
npm install -g gulp bower
npm install
bower intall
npm run app
```

The application depends on `config.js` which is not distributed with this repository.  To obtain
your own, please contact the [<EMAIL>](<<EMAIL>>)

### Testing

To test the application, use npm.
```sh
npm test
```

### Version 1 Feature Set
 1. CRUD for users
 2. CRUD for projects
 3. CRUD for requests
 4. PKI-based signatures and verification
 5. Printable requests with custom headers
 6. Basic email functionality
   1. Password reset
   2. Signup/welcome
   3. Pending authorizations
   4. Notification of authorization

### Development Progress
 - [x] Implement project management
 - [x] Automatic database builds
 - [x] Automatic testing
 - [ ] Development/production environmental variable switch
 - [ ] Implement email-based signin (tokens) 
 - [ ] Enable token-based signing
 - [ ] Full HTTP API tests written using `chai-http`
 - [ ] Automatic deployment using [CircleCI](https://circleci.com/)
 - [ ] HTTPS certificates using [LetsEncrypt](https://letsencrypt.org/)

### LICENSE
[MIT](./LICENSE)
<commit_msg>DOCS(readme): improved build documentation<commit_after>Wenge
=====

[![Circle CI](https://circleci.com/gh/IMA-WorldHealth/wenge.svg?style=shield)](https://circleci.com/gh/IMA-WorldHealth/wenge)
[![Dependency Status](https://david-dm.org/IMA-WorldHealth/wenge.svg)](https://david-dm.org/IMA-WorldHealth/wenge)
[![devDependency Status](https://david-dm.org/IMA-WorldHealth/wenge/dev-status.svg)](https://david-dm.org/IMA-WorldHealth/wenge#info=devDependencies)
[![bitHound Overall Score](https://www.bithound.io/github/IMA-WorldHealth/wenge/badges/score.svg)](https://www.bithound.io/github/IMA-WorldHealth/wenge)


Wenge is a web application for creating, reviewing, and approving Authorizations for Expenditure (AFEs).
This is an experimental application written to transition the IMA World Health office in
Kinshasa to a paperless AFE system.

### Installation

You need [nodejs](https://nodejs.org) and [sqlite3](https://www.sqlite.org/).  To install, use npm.
```sh
npm install -g gulp bower
npm install
bower install
npm run app
```

The application depends on `.env` which is not distributed with this repository.  To create your own,
please follow the guidelines in `.env.sample`.  Otherwise, email the developers [<EMAIL>](<<EMAIL>>)

### Testing

To test the application, use npm.
```sh
npm test
```

### Version 1 Feature Set
 1. CRUD for users
 2. CRUD for projects
 3. CRUD for requests
 4. PKI-based signatures and verification
 5. Printable requests with custom headers
 6. Basic email functionality
   1. Password reset
   2. Signup/welcome
   3. Pending authorizations
   4. Notification of authorization

### Development Progress
 - [x] Implement project management
 - [x] Automatic database builds
 - [x] Automatic testing
 - [X] Development/production environmental variable switch
 - [ ] Implement email-based signin (tokens)
 - [ ] Full HTTP API tests written using `mocha`/`chai-http`
 - [ ] Automatic deployment using [CircleCI](https://circleci.com/)
 - [ ] HTTPS certificates using [LetsEncrypt](https://letsencrypt.org/)

### LICENSE
[MIT](./LICENSE)

{'fraction_non_alphanumeric': 0.13137973137973138, 'fraction_numerical': 0.005860805860805861, 'mean_word_length': 4.527665317139001, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 24, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4055090', 'n_tokens_mistral': 1327, 'n_tokens_neox': 1249, 'n_words': 370}