See karstology.crawfordstewardship.org/about to learn more about this project.
The most comprehensive description of the tech stack can currently be found in this pull request.
This project was developed by Crawford Stewardship Project and Legion GIS. Much credit is due to the open source software components that make it work:
You can set up a local development version of this web application with these steps. This guide works for Ubuntu/Debian Linux.
sudo apt install python3-venv libgdal-dev nodejs npm
We also recommend Docker for running Postgres/PostGIS, though there are other ways you can install that.
Get the repo:
git clone https://github.com/legiongis/karstography && cd karstography
Create and activate virtual environment (there are other ways to do this too, like with Conda)
python3 -m venv env && source ./env/bin/activate
Install the Python dependencies:
pip install -r requirements.txt
Create a new postgres user and database:
psql -U postgres
> CREATE USER karstographer WITH ENCRYPTED PASSWORD 'karstographer_pw';
> ALTER ROLE karstographer WITH SUPERUSER;
> CREATE DATABASE karstography WITH OWNER karstographer;
Create a new file karstography/settings_local.py and put the following database settings into it (make sure this matches the db name, user, and password you created above):
from .settings import DATABASES
DEBUG = TRUE
## local db settings
DATABASES['default']['NAME'] = 'karstography'
DATABASES['default']['USER'] = 'karstographer'
DATABASES['default']['PASSWORD'] = 'karstographer_pw'
Run the database initialization command:
python manage.py setup_db
You should now be able to run the Django dev server without error:
python manage.py runserver
In a new terminal/console, enter the frontend directory and install the javascript requirements:
cd frontend
npm install
For a development build of the frontend (will reload every time you change a file), run
npm run dev
With the Django dev server running from the above step, you should now be able to open the web app in a browser at localhost:8000.
The database holds geospatial data, like sink locations, that needs to be served to the map. We use pg_tileserv for this.
The /docs directory holds the static content generator for all of that pages under /about. These docs were created using django-docs and Sphinx.
The theme used is romnnn_sphinx_press_theme (with custom CSS to match the main site) and the parser is recommonmark to support Markdown.
To regenerate docs after a modification, use:
cd docs
make html