<commit_before># Dream Flight

A wonderful example of a REST-ful api using [Restify](http://restify.com/) incorporating some of my thoughts on [Best Practices for Building REST Apis](https://github.com/psenger/Best-Practices-For-Rest-API). The application simply accepts an array of flights, filters them, transforms the results, and returns them all in a Functional, Single Responsibility Principle, Composition fashion.

Written by <NAME>

[<EMAIL>](mailto:<EMAIL>) | mobile: 0404466846 | [CV/Resume](http://www.visualcv.com/philipsenger) | [blog](http://www.apachecommonstipsandtricks.blogspot.com/) | [LinkedIn](http://au.linkedin.com/in/philipsenger) | [twitter](http://twitter.com/PSengerDownUndr) | [keybase](https://keybase.io/psenger)

## Table of Contents

<!-- toc -->

  * [Status](#status)
    + [Master Branch](#master-branch)
    + [Development Branch](#development-branch)
  * [Environment Variables](#environment-variables)
    + [Production](#production)
    + [Development and Testing](#development-and-testing)
  * [API Docs for Dream Flight, version 1.0.0](#api-docs-for-dream-flight-version-100)
    + [Endpoints](#endpoints)
      - [POST /flight](#post-flight)
        * [Response: 200](#response-200)
        * [Response: 409](#response-409)
  * [Available Scripts for Command Line](#available-scripts-for-command-line)
    + [`npm start`](#npm-start)
    + [`npm test`](#npm-test)
    + [`npm run doc`](#npm-run-doc)
  * [Versions](#versions)
  * [Directory Structure](#directory-structure)
  * [Technologies used](#technologies-used)
  * [Requirements](#requirements)
    + [Error handling](#error-handling)
    + [Deploying](#deploying)
  * [Developer Notes](#developer-notes)
- [Known Issues](#known-issues)

<!-- tocstop -->

## Status

### Master Branch
[![Build Status](https://travis-ci.org/psenger/dream-flight.svg?branch=master)](https://travis-ci.org/psenger/dream-flight)
[![Coverage Status](https://coveralls.io/repos/github/psenger/dream-flight/badge.svg?branch=master)](https://coveralls.io/github/psenger/dream-flight?branch=master)

### Development Branch
[![Build Status](https://travis-ci.org/psenger/dream-flight.svg?branch=master)](https://travis-ci.org/psenger/dream-flight)

## Environment Variables

### Production

| Mandate  | Name      | Purpose                       | ex |
|:---------|:----------|:------------------------------|:---|
| optional | PORT      | The Port number that the API should listen to. The default if not set is 3000 | ``export PORT=8080`` |
| required | NODE_ENV  | When you deploy to production, set this to 'production' to control the level of logging. | `export NODE_ENV=production`  |
<commit_msg>mod readme<commit_after># Dream Flight

A wonderful example of a REST-ful api using [Restify](http://restify.com/) incorporating some of my thoughts on [Best Practices for Building REST Apis](https://github.com/psenger/Best-Practices-For-Rest-API). The application simply accepts an array of flights, filters them, transforms the results, and returns them all in a Functional, Single Responsibility Principle, Composition fashion.

Written by <NAME>

[<EMAIL>](mailto:<EMAIL>) | mobile: 0404466846 | [CV/Resume](http://www.visualcv.com/philipsenger) | [blog](http://www.apachecommonstipsandtricks.blogspot.com/) | [LinkedIn](http://au.linkedin.com/in/philipsenger) | [twitter](http://twitter.com/PSengerDownUndr) | [keybase](https://keybase.io/psenger)

## Table of Contents

<!-- toc -->

  * [Status](#status)
    + [Master Branch](#master-branch)
    + [Development Branch](#development-branch)
  * [Environment Variables](#environment-variables)
    + [Production](#production)
    + [Development and Testing](#development-and-testing)
  * [API Docs for Dream Flight, version 1.0.0](#api-docs-for-dream-flight-version-100)
    + [Endpoints](#endpoints)
      - [POST /flight](#post-flight)
        * [Response: 200](#response-200)
        * [Response: 409](#response-409)
  * [Available Scripts for Command Line](#available-scripts-for-command-line)
    + [`npm start`](#npm-start)
    + [`npm test`](#npm-test)
    + [`npm run doc`](#npm-run-doc)
  * [Versions](#versions)
  * [Directory Structure](#directory-structure)
  * [Technologies used](#technologies-used)
  * [Requirements](#requirements)
    + [Error handling](#error-handling)
    + [Deploying](#deploying)
  * [Developer Notes](#developer-notes)
- [Known Issues](#known-issues)

<!-- tocstop -->

## Status

### Master Branch
[![Build Status](https://travis-ci.org/psenger/dream-flight.svg?branch=master)](https://travis-ci.org/psenger/dream-flight)
[![Coverage Status](https://coveralls.io/repos/github/psenger/dream-flight/badge.svg?branch=master)](https://coveralls.io/github/psenger/dream-flight?branch=master)

### Development Branch
[![Build Status](https://travis-ci.org/psenger/dream-flight.svg?branch=development)](https://travis-ci.org/psenger/dream-flight)
[![Coverage Status](https://coveralls.io/repos/github/psenger/dream-flight/badge.svg?branch=development)](https://coveralls.io/github/psenger/dream-flight?branch=development)


## Environment Variables

### Production

| Mandate  | Name      | Purpose                       | ex |
|:---------|:----------|:------------------------------|:---|
| optional | PORT      | The Port number that the API should listen to. The default if not set is 3000 | ``export PORT=8080`` |
| required | NODE_ENV  | When you deploy to production, set this to 'production' to control the level of logging. | `export NODE_ENV=production`  |

{'fraction_non_alphanumeric': 0.18185104844540853, 'fraction_numerical': 0.013015184381778741, 'mean_word_length': 4.039162112932605, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 18, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 9, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6730238', 'n_tokens_mistral': 1888, 'n_tokens_neox': 1662, 'n_words': 347}