Skip to content
MapServer and PHP-MapScript application to create publication-quality maps
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis
Tests
config
db
deploy
i18n
log
mapserver
public
src
views
.coveralls.yml
.gitignore
.travis.yml
LICENSE
README.md
composer.json
composer.lock
favicon.ico
index.php

README.md

SimpleMappr Installation and Configuration

SimpleMappr, http://www.simplemappr.net is a web-based application that produces publication-quality geographic maps. This source code is released under MIT license.

Developer: David P. Shorthouse
Email: davidpshorthouse@gmail.com

Build Status Coverage Status DOI Join the chat at https://gitter.im/dshorthouse/SimpleMappr

Server Requirements

See how the travis.yml file is configured for Travis-CI's continuous integration of automated unit and functional testing.

  1. PHP5.6+ [with cli, PDO, PDO-MySQL, GD]
  2. Apache2.2.24+ [with rewrite]
  3. MySQL 5.5.27+
  4. MapServer 7.2.0 [with PROJ, GDAL, GEOS, Cairo]
  5. Composer

Configuration Instructions

  1. Download shapefiles from Natural Earth Data, http://www.naturalearthdata.com/ and extract into mapserver/maps/. Adjust Apache read permissions as necessary.
  2. Rename and adjust:
  1. Adjust config/conf.test.php used during execution of tests
  2. If you wish to use Janrain's OpenID authentication system, sign-up at http://rpxnow.com and replace the RPX_KEY in config/conf.php
  3. The jQuery-based front-end assumes clean URLs and operates in a RESTful fashion. Configure mod_rewrite as follows:

Apache Rewrite Configuration

<VirtualHost *:80>
  ServerName mydomain.net
  ServerAlias mydomain.net
  DocumentRoot /path/to/your/root
  <Directory "/path/to/your/root">
   Options -Indexes +FollowSymlinks
   AllowOverride None
   Order allow,deny
   Allow from all
   DirectoryIndex index.php
   RewriteEngine on
   RewriteBase /
   RewriteRule ^(public|sitemap.xml|robots.txt)($|/) - [L]
   RewriteCond %{DOCUMENT_ROOT}%{REQUEST_FILENAME} !-f
   RewriteCond %{DOCUMENT_ROOT}%{REQUEST_FILENAME} !-d
   RewriteRule ^(.*)$ index.php?q=$1 [L,QSA]
  </Directory>
</VirtualHost>

Homebrew on Mac OSX

  1. Install PHP5.6. See https://github.com/homebrew/homebrew-php

  2. Execute from command line:

     $ brew install \
       autoconf \
       freetype \
       jpeg \
       libpng \
       gd --with-freetype --with-png --with-jpeg --with-tiff \
       gdal \
       geos \
       gettext \
       icu4c \
       proj \
       cairo \
       libsvg-cairo \
       fribidi \
       phpunit \
       composer
    
  3. Download MapServer 7.2.0 tarball, http://download.osgeo.org/mapserver/mapserver-7.2.0.tar.gz

  4. Extract and cd into folder

  5. Execute from command line:

       $ mkdir build; cd build; cmake .. \
         -DCMAKE_PREFIX_PATH="/usr/local/opt/libiconv;/usr/local/opt/php56;/usr/local/opt/phpunit;/usr/local/opt/geos;/usr/local/opt/pkg-config;/usr/local/opt/libxml2;/usr/local/opt/zlib;/usr/local/opt/fontconfig;/usr/local/opt/cairo;/usr/local/opt/fribidi;/usr/local/opt/proj;/usr/local/opt/giflib;/usr/local/opt/freetype;/usr/local/opt/libsvg;/usr/local/opt/libsvg-cairo;/usr/local/opt/gdal2;/usr/local/opt/libpng;/usr/local/opt/libjpeg;/usr/local/opt/harfbuzz;/usr/local/opt/exempi" \
         -DWITH_KML=1 \
         -DWITH_PHP=1 \
         -DWITH_EXEMPI=1 \
         -DWITH_SVGCAIRO=1 \
         -DWITH_FCGI=0 \
         -DWITH_RSVG=0 \
         -DWITH_POSTGIS=0 \
         -DFRIBIDI_INCLUDE_DIR="/usr/local/include/glib-2.0;/usr/local/lib/glib-2.0/include;/usr/local/include" \
         -DPHP5_INCLUDE_PATH="/usr/local/include/php"
    
       $ make && make install
    
  6. Verify that mapserv is working

       $ mapserv -v
    
  7. Add extension=php_mapscript.so to php.ini (if not already there) and restart web server

Unix-based Server

See the useful guide on MapServer.

Internationalization

The following two commands make a messages.po file (by reading the index.php file) then a binary messages.mo file from a messages.po file as input. Both need to be moved to relevant i18n directory such as i18n/fr_FR.UTF-8/LC_MESSAGES. You'll need to translate the strings in messages.po before making the binary of course. Whenever any string is changed in any messages.po file, the messages.mo file must be generated and Apache must be restarted because translated strings are enumerated into memory when the application first loads.

$ xgettext -n index.php
$ msgfmt messages.po

Alternatively, you can use the ruby utility, crawler.rb from the /i18n directory to make a messages.po file and move it to i18n/fr_FR.UTF-8/LC_MESSAGES.

$ cd i18n
$ ruby crawler.rb ../views

Dependencies

Install all necessary application dependencies using composer and update them as required.

$ composer install
$ composer update

Database

SimpleMappr uses MySQL and phinx for migrations. A sample schema is included in /db and migrations are stored in /db/migrations. Create MySQL databases simplemappr, simplemappr_development and simplemappr_testing. Use /db/sample.db.sql to create tables.

$ ./vendor/bin/phinx migrate -c config/phinx.yml -e development

Tests

PHPUnit is used for unit tests and Selenium and Facebook's php-webdriver are used for integration tests. Composer is used to include dependencies. The Firefox Gecko driver can be downloaded here.

$ java -Dwebdriver.gecko.driver=/usr/local/bin/geckodriver -jar /usr/local/bin/selenium-server-standalone-3.9.1.jar
$ BROWSER=firefox ./vendor/bin/phpunit -c Tests/phpunit.xml --stderr

If you wish to use Chrome instead of FireFox, the Selenium Chromedriver can be found at http://chromedriver.storage.googleapis.com/index.html:

$ java -Dwebdriver.chrome.driver=/usr/local/bin/chromedriver -jar /usr/local/bin/selenium-server-standalone-3.9.1.jar
$ BROWSER=chrome ./vendor/bin/phpunit -c Tests/phpunit.xml --stderr

Tests are split into suites entitled, "Unit", "Functional", "Binary", "Router"

$ ./vendor/bin/phpunit -c Tests/phpunit.xml --testsuite "Unit" --stderr

JavaScript Minification

JavaScript files are minified using Google's Closure Compiler as follows:

$ java -jar compiler.jar --js simplemappr.js --js_output_file simplemappr.min.js

Copyright

Copyright (c) 2010-2018 David P. Shorthouse

Released under MIT License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
You can’t perform that action at this time.