<commit_before># RouteMe-API
[![Build Status](https://travis-ci.org/heshamMassoud/RouteMe-API.svg?branch=master)](https://travis-ci.org/heshamMassoud/RouteMe-API)

A JSON-Based RESTful API for the RouteME collaborative multi-modal route recommender app. This API is build as a backend support for the prototype iOS app RouteMe which is developed as a prototype to support the research of my Master thesis topic which is "Collaborative and Social Multi-modal Route Planning"

## Run the API application locally
Start the MongoDB instance first and then you're good to start the API server and start using it.
```
mvn clean install
mvn clean package
java -jar 'path to created jar'
```
## Data persistence
The data store used is MongoDB
###### Start MongoDB locally
`mongod`
###### The API server by default now points to the database
`test`
###### To connect to MongoDB through CLI
`mongo db`


## PredictionIO setup
#### CLI
Interaction with PredictionIO is done through the CLI. It follows the format of:

`pio <command> [options] <args>...`

You can run pio help to see a list of all available commands and pio help <command> to see details of the command.

PredictionIO commands can be separated into the following three categories.

##### General Commands

`pio help` Display usage summary. pio help <command> to read about a specific subcommand.

`pio version` Displays the version of the installed PredictionIO.

`pio status` Displays install path and running status of PredictionIO system and its dependencies.

##### Event Server Commands

`pio eventserver` Launch the Event Server.

`pio app` Manage apps that are used by the Event Server.

`pio app data-delete <name>` deletes all data associated with the app.
<commit_msg>Update README.md PredictionIO info<commit_after># RouteMe-API
[![Build Status](https://travis-ci.org/heshamMassoud/RouteMe-API.svg?branch=master)](https://travis-ci.org/heshamMassoud/RouteMe-API)

A JSON-Based RESTful API for the RouteME collaborative multi-modal route recommender app. This API is build as a backend support for the prototype iOS app RouteMe which is developed as a prototype to support the research of my Master thesis topic which is "Collaborative and Social Multi-modal Route Planning"

## Run the API application locally
Start the MongoDB instance first and then you're good to start the API server and start using it.
```
mvn clean install
mvn clean package
java -jar 'path to created jar'
```
## Data persistence
The data store used is MongoDB
###### Start MongoDB locally
`mongod`
###### The API server by default now points to the database
`test`
###### To connect to MongoDB through CLI
`mongo db`


## PredictionIO setup
### Installation 
https://docs.prediction.io/install/
### Usage
Interaction with PredictionIO is done through the CLI. It follows the format of:

`pio <command> [options] <args>...`

You can run pio help to see a list of all available commands and pio help <command> to see details of the command.

PredictionIO commands can be separated into the following three categories.

##### General Commands

`pio help` Display usage summary. pio help <command> to read about a specific subcommand.

`pio version` Displays the version of the installed PredictionIO.

`pio status` Displays install path and running status of PredictionIO system and its dependencies.

##### Event Server Commands

`pio eventserver` Launch the Event Server.

`pio app` Manage apps that are used by the Event Server.

`pio app data-delete <name>` deletes all data associated with the app.

{'fraction_non_alphanumeric': 0.07905138339920949, 'fraction_numerical': 0.0, 'mean_word_length': 4.686998394863563, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 5, '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': '549194', 'n_tokens_mistral': 982, 'n_tokens_neox': 947, 'n_words': 489}