diff --git a/README.md b/README.md index 59899c9d..2fc97856 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ Windshaft-CartoDB ================== -This is the CartoDB map tiler. It extends Windshaft with some extra functionality and custom filters for authentication - -Look at lib/cartodb/server_options for more on config +This is the CartoDB map tiler. It extends Windshaft with some extra +functionality and custom filters for authentication * reads dbname from subdomain and cartodb redis for pretty tile urls * configures windshaft to publish cartodb_id as the interactivity layer @@ -13,15 +12,38 @@ Look at lib/cartodb/server_options for more on config * provides a infowindow endpoint for windshaft * provides a map_metadata endpoint for windshaft - Install ------- + ``` git clone npm install +``` + +Note that the ```npm install``` step will populate the node_modules/ +directory with modules, some of which being compiled on demand. If you +happen to have startup errors you may need to force rebuilding those +modules. At any time just wipe out the node_modules/ directory and run +```npm install``` again. + +Configure +--------- + +Edit config/environments/.js files + +Look at lib/cartodb/server_options for more on config + +Run +--- + +``` node app.js [development | production] ``` +Note that caches are kept in redis. If you're not seeing what +you expect there may be out-of-sync records in there. +Take a look: http://redis.io/commands + URLs ---- @@ -34,7 +56,8 @@ Args: * sql - plain SQL arguments * interactivity - specify the column to use in UTFGrid -* cache_buster - if needed you can add a cachebuster to make sure you're rendering new +* cache_buster - if needed you can add a cachebuster to make sure you're + rendering new * geom_type - override the cartodb default * style - override the default map style with Carto @@ -66,4 +89,5 @@ Args: * infowindow - returns contents of infowindow from CartoDB. -All GET requests are wrappable with JSONP using callback argument, including the UTFGrid map tile call. \ No newline at end of file +All GET requests are wrappable with JSONP using callback argument, +including the UTFGrid map tile call.