GeoSight

QUICK INSTALLATION GUIDE

Production

git clone https://github.com/unicef-drp/GeoSight
cd GeoSight/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
cd GeoSight/deployment
cp .template.env .env
docker-compose.override.template.yml docker-compose.override.yml

cd GeoSight
make up
make dev

Run the frontend dev with frontend-dev

Pycharm

Under Construction

The web will be available at http://localhost:2000/

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/.

dimasciput/GeoSight