📘 API Reference Overview¶

🧭 Georama Module Structure¶

graph TD;
  georama["Georama (Project Root)"]

  georama --> core("core<br><sub>Base settings, models, utils</sub>")
  georama --> data_integration["data_integration<br><sub>QGIS import, sync</sub>"]
  georama --> features["features<br><sub>OGC API logic, permissions</sub>"]
  georama --> maps["maps<br><sub>WMS, layer registry</sub>"]
  georama --> webgis["webgis<br><sub>Frontend integration, views</sub>"]

🧩 Core Module¶

In the core module, we define the base settings, models, and utils. We also have some custom permissions handling. Functions and templates which are used in the other modules are also defined in the core module.

core/
├── auth (basic auth)
├── entities (basic permission handling of the different ressources)
└── templates (custom templates)

Core API Reference.

🔄 Data Integration Module¶

Integrates geodata from QGIS Projects. Here we have the definitions of the Mandant, Project and the different Datasets, which are used to read in the QGIS Projects.

data_integration/
├── migrations
└── templates

Data Integration API Reference.

🌐 Features Module¶

Extracts vector features with pygeoapi power and serves them as OGC API Features.

features/
├── migrations
├── pygeoapi_providers
├── static
└── templates

Features API Reference.

🗺️ Maps Module¶

Draws Maps with QGIS power via QGIS-Server-Light and serves them as WMS.

maps/
├── interfaces
├── migrations
├── services
├── static
└── templates

Maps API Reference.

🌍 WebGIS Module (Under development)¶

Will later serve geo data with geogirafe as frontend.

webgis/
├── interfaces
├── management
├── migrations
├── static
└── templates

WebGIS API Reference.