<commit_before>##Trippian 
[![Travis](https://img.shields.io/travis/rust-lang/rust.svg?style=flat-square)](https://travis-ci.org/vidaaudrey/trippian)
[![codecov coverage](https://img.shields.io/codecov/c/github/vidaaudrey/trippian/develop.svg?style=flat-square)](https://codecov.io/github/vidaaudrey/trippian?branch=develop)
[![npm version](https://badge.fury.io/js/trippian.svg)](https://badge.fury.io/js/trippian)
[![Downloads](http://img.shields.io/npm/dm/trippian.svg?style=flat-square)](https://npmjs.org/package/trippian)
[![Issue Stats](http://issuestats.com/github/trippian/trippian/badge/pr)](http://issuestats.com/github/trippian/trippian)
[![Issue Stats](http://issuestats.com/github/trippian/trippian/badge/issue)](http://issuestats.com/github/trippian/trippian)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)

Your local trip companion! Trippian is a web application that allows tourists (Trippees) to connect with a Trippian, a local who wants to show people around and show them what it would be like to live in a different city/country.

###Architecture

####Database Design
<img src="https://s3-us-west-1.amazonaws.com/trippian/Trippian+Database+Schema.png" width="500">

###Setup
For this project, we develop using webpack to bundle our react code and gulp to watch and compile all our styling files. Thus, during development, we have the server running on localhost port 4000 and our webpack server on localhost port 3000.

- `npm install` to install our dependencies
- `npm run dev` will start the dev server and run/watch all test files ending with '*.spec.js'.
- `npm run start:server` will start our main server on localhost:4000
- `npm run build`, will build the bundle.js file in the dist folder and copy all asset files from dist to deploy folder. 
- NOTE: our main server will serve up the deploy folder, so if you would like to see updates on localhost:4000, you must run `npm run build`
- `npm run commit` follows commitizen guidelines and will help you figure out which commit message to use.

We used the dotenv npm package to configure our development variables. To run locally, you must create a .env file in the root directory and add in these variables. Here is a template file: [dotenvTemplate](https://github.com/trippian/trippian/blob/master/dotenvTemplate)

- HOST, FACEBOOK_APP_ID, FACEBOOK_APP_SECRET, FACEBOOK_CALLBACK_URL, GRAPHSTORY_URL, S3_BUCKET, AWS_ACCESS_KEY_ID, AWS_SECRET_KEY, GOOGLE_APP_ID, GOOGLE_APP_SECRET, GMAIL_ACCOUNT, GMAIL_PWD, GOOGLE_MAPS_API_KEY

###Testing
For Client-side testing, we used mocha and chai and for server-side testing, we user mocha and chai with supertest. Supertest is a great library for testing routes on your server. It creates an instance of your server that you can test. For more information click this [link](https://github.com/visionmedia/supertest)

`npm run test`
`npm run test:server`
This will watch *.spec.js and run the test (update this part later)

### Styling
All our styling files, including static assets and scss files are inside the `_planning/static/` directory

When making changes to the styling, run `gulp`. This will watch any changes in the `_planning/static/src/` folder and auto-reload the files after any changes.

When you are done making changes to the styling, run `gulp copy` and then all the files in `_planning/static/build/` except any html files will be copies to the `dist` folder.

###Contributing
Check out our [contributing guide](https://github.com/trippian/trippian/blob/master/CONTRIBUTING.md) to see how to get started in contributing to our project!

### Technology Stack
- React
- Node/Express
- Neo4j
- Babel/ES6
- Travis CI
- Mocha
- Chai
- AWS S3
- webpack
- Sass
- Gulp

###API Documentation
For any information on any of the REST endpoints, check out our API specifications doc [here](https://github.com/trippian/trippian/wiki/APISpec)<commit_msg>docs: add team with github links<commit_after>##Trippian 
[![Travis](https://img.shields.io/travis/rust-lang/rust.svg?style=flat-square)](https://travis-ci.org/vidaaudrey/trippian)
[![codecov coverage](https://img.shields.io/codecov/c/github/vidaaudrey/trippian/develop.svg?style=flat-square)](https://codecov.io/github/vidaaudrey/trippian?branch=develop)
[![npm version](https://badge.fury.io/js/trippian.svg)](https://badge.fury.io/js/trippian)
[![Downloads](http://img.shields.io/npm/dm/trippian.svg?style=flat-square)](https://npmjs.org/package/trippian)
[![Issue Stats](http://issuestats.com/github/trippian/trippian/badge/pr)](http://issuestats.com/github/trippian/trippian)
[![Issue Stats](http://issuestats.com/github/trippian/trippian/badge/issue)](http://issuestats.com/github/trippian/trippian)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)

Your local trip companion! Trippian is a web application that allows tourists (Trippees) to connect with a Trippian, a local who wants to show people around and show them what it would be like to live in a different city/country.

###Architecture

####Database Design
<img src="https://s3-us-west-1.amazonaws.com/trippian/Trippian+Database+Schema.png" width="500">

###Setup
For this project, we develop using webpack to bundle our react code and gulp to watch and compile all our styling files. Thus, during development, we have the server running on localhost port 4000 and our webpack server on localhost port 3000.

- `npm install` to install our dependencies
- `npm run dev` will start the dev server and run/watch all test files ending with '*.spec.js'.
- `npm run start:server` will start our main server on localhost:4000
- `npm run build`, will build the bundle.js file in the dist folder and copy all asset files from dist to deploy folder. 
- NOTE: our main server will serve up the deploy folder, so if you would like to see updates on localhost:4000, you must run `npm run build`
- `npm run commit` follows commitizen guidelines and will help you figure out which commit message to use.

We used the dotenv npm package to configure our development variables. To run locally, you must create a .env file in the root directory and add in these variables. Here is a template file: [dotenvTemplate](https://github.com/trippian/trippian/blob/master/dotenvTemplate)

- HOST, FACEBOOK_APP_ID, FACEBOOK_APP_SECRET, FACEBOOK_CALLBACK_URL, GRAPHSTORY_URL, S3_BUCKET, AWS_ACCESS_KEY_ID, AWS_SECRET_KEY, GOOGLE_APP_ID, GOOGLE_APP_SECRET, GMAIL_ACCOUNT, GMAIL_PWD, GOOGLE_MAPS_API_KEY

###Testing
For Client-side testing, we used mocha and chai and for server-side testing, we user mocha and chai with supertest. Supertest is a great library for testing routes on your server. It creates an instance of your server that you can test. For more information click this [link](https://github.com/visionmedia/supertest)

`npm run test`
`npm run test:server`
This will watch *.spec.js and run the test (update this part later)

### Styling
All our styling files, including static assets and scss files are inside the `_planning/static/` directory

When making changes to the styling, run `gulp`. This will watch any changes in the `_planning/static/src/` folder and auto-reload the files after any changes.

When you are done making changes to the styling, run `gulp copy` and then all the files in `_planning/static/build/` except any html files will be copies to the `dist` folder.

###Contributing
Check out our [contributing guide](https://github.com/trippian/trippian/blob/master/CONTRIBUTING.md) to see how to get started in contributing to our project!

### Technology Stack
- React
- Node/Express
- Neo4j
- Babel/ES6
- Travis CI
- Mocha
- Chai
- AWS S3
- webpack
- Sass
- Gulp

###API Documentation
For any information on any of the REST endpoints, check out our API specifications doc [here](https://github.com/trippian/trippian/wiki/APISpec)

###Team
- <NAME>: [github](https://github.com/vidaaudrey)
- <NAME>: [github](https://github.com/jlag34)
- <NAME>: [github](https://github.com/ycube)
- <NAME>: [github](https://github.com/elliotschi)
{'fraction_non_alphanumeric': 0.11398478642480983, 'fraction_numerical': 0.010532475131655939, 'mean_word_length': 5.035310734463277, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 34, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6355983', 'n_tokens_mistral': 2821, 'n_tokens_neox': 2673, 'n_words': 881}