Skip to content

Latest commit

 

History

History
125 lines (90 loc) · 3.71 KB

README.md

File metadata and controls

125 lines (90 loc) · 3.71 KB
Raw

GeoSight

GeoSight is a UNICEF’s open-source geospatial web-based data visualization/analysis platform that aims to make geospatial data easily accessible and shareable in support of risk informed programming. This data is displayed utilizing administrative reference datasets from GeoRepo.

Key Concepts

A project (dashboard) is the most important feature of GeoSight. Projects combine different elements (Reference datasets, indicators, and context layers) and enable data visualization/analysis for all end users.

Context layers are geospatial layers used to contextualise the information presented in a project.

Indicators layers derive from spreadsheets or other intelligence assets harvested by the platform.

Widgets are visual components such as charts generated by performing data analysis on country/regional levels and the indicator data.

☑️ Project activity

Tests

Production

git clone https://github.com/unicef-drp/GeoSight-OS
cd GeoSight-OS/deployment
docker-compose up -d

The web will be available at http://127.0.0.1/

To stop containers:

docker-compose kill

To stop and delete containers:

docker-compose down

Development

git clone https://github.com/unicef-drp/GeoSight-OS
cd GeoSight-OS/deployment
cp .template.env .env
cp docker-compose.override.template.yml docker-compose.override.yml

After that, do

  • open new terminal
  • on folder root of project, do
make frontend-dev

Wait until it is done when there is sentence "webpack xxx compiled successfully in xxx ms".
After that, don't close the terminal. If it is accidentally closed, do make frontend-dev again

Next step:

  • Open new terminal
  • Do commands below
make up
make dev

Wait until it is on.

The web can be accessed using http://localhost:2000/

If the web is taking long time to load, restart geosight_dev container.
The sequence should be make frontend-dev, after that run or restart geosight_dev.

Demo data

Demo data command can be done after development server is run.

Do

make devweb-load-demo-data

and it will restore demo data to GeoSight. After that, you need to update the GeoRepo configuration.
The demo data is using https://georepo.unicef.org/api/v1/, so you need to ask API Key Level 1 and Level 4 from GeoRepo.
Or you can use your API key, and just put your api key to Level 1 and Level 4 (same api key).

Setup GeoRepo configuration

There are GeoRepo configurations that are needed for geosight.
Go to '/django-admin/core/sitepreferences/1/change/', use admin username/password on .env file (ADMIN_USERNAME and ADMIN_PASSWORD).
Change Georepo url and fill Georepo API Key. For Georepo API Key, you can ask georepo for the key. GeoRepo URL is basically, GeoRepo API URL. The url should be https:///api/v1/, e.g: https://georepo.unicef.org/api/v1/.

Building the documentation as a PDF

Install Dependencies

You need to install these packages:

pip install mkdocs-with-pdf
pip install mkdocs-material
pip install mdx_gh_links
pip install mkdocs-pdf-export-plugin

Building in a terminal

Note that whenever you add new sections to nav in the mkdocs.yml (used for building the web version), you should apply those same edits to mkdocs-pdf.yml if you want those new sections to appear in the pdf too.

cd  docs
./build-docs-pdf.sh
xdg-open TheGeosightHandbook.pdf

Building in VSCode

If you are in VSCode, you can also just run the 'Compile PDF' task. The generated PDF will be placed in docs/pdfs/.