Initial commit - Trekker V2 source
This commit is contained in:
commit
d71faf19e3
65 files changed
+3615
No files matched your search
@@ -0,0 +1,51 @@
|
||||
# Trekker
|
||||
|
||||
Vehicle-aware overland trip intelligence. Ingests GPX (upload + watch
|
||||
folders), trail guides (web scrape / PDF + LLM extraction), Open-Meteo
|
||||
weather, and offline map areas; generates trail cards and map overlays; and
|
||||
exports enriched GPX/KML for onX and Gaia GPS.
|
||||
|
||||
See [PLAN.md](PLAN.md) for architecture and design decisions.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
uvicorn app.main:app --reload
|
||||
# open http://localhost:8000/app
|
||||
```
|
||||
|
||||
Optional config: copy `trekker.yml.example` → `trekker.yml` (watch folders,
|
||||
LLM provider, tile sources, sync peer) and `.env.example` → `.env`.
|
||||
|
||||
## Docker
|
||||
|
||||
```bash
|
||||
# Home server
|
||||
docker compose up -d --build
|
||||
|
||||
# Neutron (truck server, with Tailscale sidecar)
|
||||
TAILSCALE_AUTH_KEY=tskey-... \
|
||||
docker compose -f docker-compose.yml -f docker/docker-compose.neutron.yml up -d --build
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
python -m pytest tests/
|
||||
```
|
||||
|
||||
## API surface
|
||||
|
||||
| Endpoint | What |
|
||||
| :--- | :--- |
|
||||
| `POST /api/routes/upload` | Upload a GPX file → segmented `TrekkerRoute` |
|
||||
| `GET /api/routes` / `GET /api/routes/{id}` | List / fetch routes |
|
||||
| `PUT /api/routes/{id}/trail-guide` | Link/unlink a trail guide |
|
||||
| `POST /api/routes/{id}/generate/{name}` | Run `trail_card`, `elevation_map`, or `weather_overlay` |
|
||||
| `POST /api/routes/{id}/refresh-weather` | Manual Open-Meteo refresh (7 or 10 days) |
|
||||
| `GET /api/routes/{id}/export?format=gpx\|kml` | Enriched export download |
|
||||
| `POST /api/trails/scrape` / `POST /api/trails/upload-pdf` | Draft guide extraction (review before saving) |
|
||||
| `POST /api/trails` | Save a reviewed trail guide |
|
||||
| `POST /api/offline-maps` (+ `/estimate`) | Create offline tile packs |
|
||||
| `POST /api/sync` | Manual sync with the configured peer |
|
||||
Reference in new issue
Block a user