Skip to content

qwikgeo/qwikgeo-api

Repository files navigation

QwikGeo API

QwikGeo Image

QwikGeo API is a enterprise scale api for a GIS portal. QwikGeo API is written in Python using the FastAPI web framework.


Source Code: https://github.com/qwikgeo/qwikgeo-api


Tech Docs

Docs available at this link.

Requirements

QwikGeo API requires PostGIS >= 2.4.0.

Configuration

In order for the api to work you will need to edit the .env with your database to host the API.

DB_HOST=localhost
DB_DATABASE=qwikgeo
DB_USERNAME=postgres
DB_PASSWORD=postgres
DB_PORT=5432
CACHE_AGE_IN_SECONDS=0
MAX_FEATURES_PER_TILE=100000
SECRET_KEY=asdasasfakjh324fds876921vdas7tfv1uqw76fasd87g2q
GOOGLE_CLIENT_ID=asdasdas745-cj472811c26nu77fm5m98dasdasdasda1vkvk2pscfasad.apps.googleusercontent.com
JWT_TOKEN_EXPIRE_IN_MIUNTES=60000

Usage

Running Locally

To run the app locally uvicorn qwikgeo_api.main:app --reload

To run the docs locally mkdocs serve

Production

Build Dockerfile into a docker image to deploy to the cloud.

Aerich Commmands

aerich init -t qwikgeo_api.main.DB_CONFIG --location migrations -s .

aerich init-db