Skip to content

tpetillon/roofmapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RoofMapper

This is the main source repository for the OpenStreetMap contribution tool RoofMapper.

It allows users to easily improve the OSM database, on a very specific subject: telling what the building's roofs are made of, according to aerial imagery. Resulting maps are generated daily from the contributions.

Server

The server is built with Node.js, uses PostGIS for data storage and Mapnik for map generation.

Dependencies

  • NPM
  • Node.js
  • PostgreSQL
    • with PostGIS extensions

Setup

  • Setup the database using instructions found in server/sql/schema.sql and server/sql/map.sql
  • Fill the database with buildings
  • Clone this repository
  • Execute npm install in the server directory
    • Mapnik comes automatically with the node-mapnik package
  • Setup the configuration
    • server/config/default.json for development
    • server/config/production.json for production
  • Add geographical data in data/mapdata
    • Currently, this dataset is required, download and extract it in the directory

Launch

  • node ./bin/www for development mode (or just npm run start)
  • NODE_ENV=production node ./bin/www for production mode

Client

The web client is packaged with Webpack.

Dependency

  • NPM

Setup

  • Clone this repository
  • Execute npm install in the client directory
  • Run npm run build for production build
  • The server automatically serves the client

When developing, it is advised to use npm run watch-dev, which rebuilds the client after each change.

License

MIT, cf. LICENSE.md.