Files
deflock/api/README.md
T
Will Freeman 64ac4c227e Multi Geocode (#109)
* multi-geocode for new map

* backward compatibility w/ city polygon
2026-04-19 15:28:05 -06:00

595 B

DeFlock API

A Fastify-based API service for DeFlock handling non-OSM related backend logic.

Endpoints

  • /geocode?query=... — Geocode a location
  • /sponsors/github?username=... — Get GitHub sponsors
  • /healthcheck — Health check

Development

Prerequisites

  • Bun installed

Install dependencies

bun install

Run locally

bun dev

Deployment

Deployed via GitHub Actions on push to master.

Environment Variables

Create a .env file in this directory with:

  • GITHUB_TOKEN — Required for GitHub Sponsors endpoint