<commit_before># Table of contents

* [Platforms](#platforms)
* [Get the source code](#get-the-source-code)
* [Dependencies](#dependencies)
    * [Node dependencies](#node-dependencies)
* [Running the project](#running-the-project)
  * [Troubleshooting](#troubleshooting)



# Platforms

You should be able to compile RealtimeServer successfully on the following
platforms:

* Linux with at least 4GB of RAM



# Get the source code

You can clone the repository and all its submodules using the
following command:

    git clone https://sasagitlab.opensasa.info/development/realtimebus-v2.git

To update an existing clone you can use the following commands:

    cd realtimebus
    git pull
    git submodule update --init --recursive



# Dependencies

To run RealtimeServer you will need:

* The latest version of [NodeJs](https://nodejs.org/en/) (Tested on v4.2.6)
* The latest version of [PostgreSQL](https://www.postgresql.org) (9.5 or greater)
* The latest version of [PostGIS](http://postgis.net) (2.2 or greater)
* The latest version of [MapServer](mapserver) (2.2 or greater) (optional)

You can install all needed dependencies using the following command:

    sudo apt install nodejs npm postgresql postgis
    
If you want to serve bus path overlays to use on a map (OSM, Google Maps), you need to install MapServer. 
Please refer to the [official installation guide](http://www.mapserver.org/installation/index.html) for help.
    

## Node dependencies

To install all needed NodeJs dependencies run the following command in your project directory:

    npm install



# Running the project

1. Enter the project directory and execute `node`:

        cd ~/RealtimeServer
        node app.js
        
2. The server should now be running on port 80 and can be accessed using:
        
        curl http://localhost/v1/
        

## Troubleshooting<commit_msg>Fixed line breaks in INSTALL.md<commit_after># Table of contents

* [Platforms](#platforms)
* [Get the source code](#get-the-source-code)
* [Dependencies](#dependencies)
    * [Node dependencies](#node-dependencies)
* [Running the project](#running-the-project)
  * [Troubleshooting](#troubleshooting)

<br/>

# Platforms

You should be able to compile RealtimeServer successfully on the following
platforms:

* Linux with at least 4GB of RAM

<br/>

# Get the source code

You can clone the repository and all its submodules using the
following command:

    git clone https://sasagitlab.opensasa.info/development/realtimebus-v2.git

To update an existing clone you can use the following commands:

    cd realtimebus
    git pull
    git submodule update --init --recursive

<br/>

# Dependencies

To run RealtimeServer you will need:

* The latest version of [NodeJs](https://nodejs.org/en/) (Tested on v4.2.6)
* The latest version of [PostgreSQL](https://www.postgresql.org) (9.5 or greater)
* The latest version of [PostGIS](http://postgis.net) (2.2 or greater)
* The latest version of [MapServer](mapserver) (2.2 or greater) (optional)

You can install all needed dependencies using the following command:

    sudo apt install nodejs npm postgresql postgis
    
If you want to serve bus path overlays to use on a map (OSM, Google Maps), you need to install MapServer. 
Please refer to the [official installation guide](http://www.mapserver.org/installation/index.html) for help.
    

## Node dependencies

To install all needed NodeJs dependencies run the following command in your project directory:

    npm install

<br/>

# Running the project

1. Enter the project directory and execute `node`:

        cd ~/RealtimeServer
        node app.js
        
2. The server should now be running on port 80 and can be accessed using:
        
        curl http://localhost/v1/
        

## Troubleshooting
{'fraction_non_alphanumeric': 0.08588794926004228, 'fraction_numerical': 0.008456659619450317, 'mean_word_length': 3.638480392156863, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 4, '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': '3451647', 'n_tokens_mistral': 1143, 'n_tokens_neox': 1072, 'n_words': 435}