Skip to main content

Quick Start

Get FastGIS running locally in a few minutes.

Prerequisites​

  • Python ≥ 3.10
  • GRASS GIS ≥ 8.x installed and on PATH
  • A running MapServer instance (optional — layers still load without it)

1. Clone and install​

git clone https://github.com/epifanio/FastGIS.git
cd FastGIS
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

2. Configure​

Copy the example environment file and fill in your values:

cp .env.example .env

Key variables:

VariableDescription
SECRET_KEYSession signing key — use a random 32-char string
GRASS_GISDBASEPath to your GRASS database directory
MAPSERVER_URLBase URL for your MapServer instance

3. Start the server​

uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

Open http://localhost:8000 in your browser.

4. Generate an API token​

  1. Navigate to Settings → Profile
  2. Click Generate token
  3. Copy the token — you will paste it into the Connection panel in the GRASS Runner

5. Open the GRASS Runner​

Click GRASS Runner in the navigation bar. Paste your token and base URL into the Connection panel, then click Connect & load environments.

:::tip First run If the connection panel is missing, make sure you're logged in and that the server started without errors. :::

Next steps​