Skip to content

Latest commit

 

History

History
178 lines (105 loc) · 4.91 KB

README.md

File metadata and controls

178 lines (105 loc) · 4.91 KB
Raw

Mapotempo Build Status

Route optimization with numerous stops. Based on OpenStreetMap and OR-Tools.

Installation

  1. Project dependencies
  2. Install Bundler Gem
  3. Requirements for all systems
  4. Install project
  5. Configuration
  6. Background Tasks
  7. Initialization
  8. Running
  9. Running on producton
  10. Launch tests

Project dependencies

On Fedora

Install ruby (>2.0 is needed), bundler and some dependencies from system package.

yum install ruby ruby-devel rubygem-bundler postgresql-devel libgeos++-dev

On other systems

Install Ruby (> 2.0 is needed) and other dependencies from system package.

For exemple, with Ubuntu, follows this instructions :

To know the last version, check with this command tools

apt-cache search [package_name]

First, install Ruby :

sudo apt-get install ruby2.3 ruby2.3-dev

Next, install Postgrsql environement :

 postgresql postgresql-client-9.5 postgresql-server-dev-9.5

You need some others libs :

libz-dev libicu-dev build-essential g++ libgeos-dev libgeos++-dev

It's important to have all of this installed packages before installing following gems.

Install Bundler Gem

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed. For more informations see Bundler website.

To install Bundler Ruby Gem:

export GEM_HOME=~/.gem/ruby/2.3
gem install bundler

The GEM_HOME variable is the place who are stored Ruby gems.

Requirements for all systems

Now add gem bin directory to path with :

export PATH=$PATH:~/.gem/ruby/2.3/bin

Add Environement Variables into the end of your .bashrc file :

nano ~/.bashrc

Add following code :

# RUBY GEM CONFIG
export GEM_HOME=~/.gem/ruby/2.3
export PATH=$PATH:~/.gem/ruby/2.3/bin

Save changes and Quit

Run this command to activate your modifications :

source ~/.bashrc

Install project

For the following installation, your current working directory needs to be the mapotempo-web root directory.

Clone the project :

git clone [email protected]:Mapotempo/mapotempo-web.git

Go to project directory :

cd mapotempo-web

And finally install gem project dependencies with :

bundle install

I you have this message :

Important: You may need to add a javascript runtime to your Gemfile in order for bootstrap's LESS files to compile to CSS.

Don't worry, we use SASS to compile CSS and not LESS.

Configuration

Override variables

Default project configuration is in config/application.rb you can override any setting by create a config/initializers/mapotempo.rb file and override any variable.

External resources can be configured trough environment variables:

  • POSTGRES_USERNAME, default: 'mapotempo'
  • POSTGRES_PASSWORD, default: 'mapotempo'
  • POSTGRES_DATABASE', default: 'mapotempo-test', 'mapotempo-dev' or 'mapotempo-prod'
  • REDIS_HOST', default: 'localhost', production environment only
  • OPTIMIZER_HOST, default: 'http://optim.mapotempo.com:1791/0.1'
  • OPTIMIZER_API_KEY
  • GEOCODER_HOST, default: 'https://geocode.mapotempo.com/0.1'
  • GEOCODER_API_KEY
  • ROUTER_API_KEY
  • DEVICE_TOMTOM_API_KEY

Background Tasks

Delayed job (background task) can be activated by setting Mapotempo::Application.config.delayed_job_use = true it's allow asynchronous running of import geocoder and optimization computation.

Default configuration point on public OSRM API but matrix computation heavily discouraged on it. So point on your own instance.

Initialization

Check database configuration in config/database.yml and from project directory create a database for your environment with :

As postgres user:

sudo -i -u postgres

Create user and databases:

createuser -s [username]
createdb -E UTF8 -T template0 -O [username] mapotempo-dev
createdb -E UTF8 -T template0 -O [username] mapotempo-test

For informations, to delete a user use :

dropuser [username]

To delete a database :

dropdb [database]

As normal user, we call rake to initialize databases (load schema and demo data) :

rake db:setup

Running

Start standalone rails server with

rails server

Enjoy at http://localhost:3000

Start the background jobs runner with

./bin/delayed_job run

Running on production

Setup assets:

rake i18n:js:export
rake assets:precompile

Launch tests

rake test

If you focus one test only or for any other good reasons, you don't want to check i18n and coverage:

rake test I18N=false COVERAGE=false