From b7293ef7017cc204ea959aab32798287f787ca0c Mon Sep 17 00:00:00 2001 From: Adi Eyal Date: Sun, 27 Sep 2020 11:58:23 +0200 Subject: [PATCH] Update README.md --- README.md | 98 ++++++++++++++++++++++++++----------------------------- 1 file changed, 46 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 6d3187b9..b68f30e1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ +# Introduction +Wazimap-NG is the next version of [Wazimap](http://www.wazimap.co.za). It provides a platform for users to bind tabular data to spatial boundaries in order create curated views of datasets. Yes - that's probably too vague a description to understand what it is. Hopefully the images below provide a better description: + +Screen-Shot-2020-09-27-at-09-50-00 Screen-Shot-2020-09-27-at-09-50-33

+Screen-Shot-2020-09-27-at-09-50-50 Screen-Shot-2020-09-27-at-09-51-30

+ +See a link to the beta site here: [https://beta.youthexplorer.org.za](https://beta.youthexplorer.org.za). + +You can find the backend code in this repository. The frontend is available here: [https://github.com/openupsa/wazimap-ng-ui](https://github.com/openupsa/wazimap-ng-ui). + +# New features + +The main new features are: + +* Admins now have more flexibility when it comes to loading data. This includes uploading massive datasets and then slicing and dicing in the backend rather than pre-preparing datasets beforehand. +* Point data is now fully integrated as a first-class spatial object. +* Choropleths built into the main view. These were hidden behind multiple clicks in the previous version. +* One platform can host multiple profiles off the same database. +* The Rich data view allows richer disaggregation of indicators. +* The administrator can configure the view to use custom basemaps, colours, and other UI settings. +* Arbitrary spatial boundaries and hierarchies can be loaded onto the same server. +* Toggling of overlapping boundary layers such as switching between wards and mainplaces which typically cover the same areas. +* Integration into third-party data sources for realtime data feeds. + +# Related software +There is no shortage of mapping software available, both commerical and open-source. Wazimap focuses on providing a platform for data custodians to showcase their datasets and mashing them up with public data. The most similar tool that we have found is the excellent [GeoNode](https://geonode.org/). We feel that approach to publishing data is significantly different enough to warrant a separate project. + +# Roadmap +Version 0.8 is due soon and will fix bugs that currently don't have workarounds. We'll publish the 1.0 roadmap soon. + +# Future features +* WFS endpoint for publishing data to other GIS software +* Pluggable data visualisations +* Better handling of geography hierarchies. +* Improved handling of temporal and other types of non-census-like data. +* Speed improvements +* A large standard database of public datasets. + # Prerequisites - [Docker](https://docs.docker.com/docker-for-mac/install/) @@ -18,58 +56,14 @@ docker-compose down docker-compose up ``` -# Production -To build a new image: - -```bash -./scripts/docker_build.sh -``` - -Note, this currently logs into adieyal on docker-hub. This will be moved to the OpenUp account in future. - - -``` - - - - +# Documentation +These are works in progress: +* [Technical manual](https://openup.gitbook.io/wazi-ng-technical/) +* [Administrator manual](https://openup.gitbook.io/wazimap-ng/) -Some notes for database migration - will turn this into proper documentation in the future +# Contributions +Contributions are welcome - we are working towards making this process easier. New development takes place in the [staging branch](https://github.com/OpenUpSA/wazimap-ng/tree/staging) -SELECT 'ALTER TABLE '|| schemaname || '.' || tablename ||' OWNER TO wazimap_ng;' -FROM pg_tables WHERE NOT schemaname IN ('pg_catalog', 'information_schema') -ORDER BY schemaname, tablename; \ No newline at end of file +# Shoulders of giants +This project is the next iteration of a number of excellent projects starting with [CensusReporter](https://censusreporter.org/) and [Wazimap](http://www.wazimap.co.za) that followed it. Special thanks to William Bird from [Media Monitoring Africa](https://mediamonitoringafrica.org) whose initial idea (and funding) it was to build a tool to help journalists better understand areas they were reporting on. Also thanks to Chris Berens from [VPUU](vpuu.org.za) who directed funding to help kickstart this new build. Finally, all of the amazing spatial software and tools developed by one of the most dedicated open source communities out there.