You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: align README and ROADMAP with 3-layer strategic architecture
- Expand Platform Vision → Strategic Architecture with Layer A/B/C
tables showing current state and next steps
- Restructure Future Ideas by architecture layer (Observation,
Intelligence, Delivery) instead of ad-hoc categories
- Add architecture diagram (ASCII box) to both files
- Reorganize README Feature Overview into Layer A/B/C sections
- Add link to docs/architecture.md for full strategic detail
- Refine vision/mission positioning statement
Copy file name to clipboardExpand all lines: README.md
+48-14Lines changed: 48 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,10 @@ Open source self-hostable and reproducible Crop Intelligence Platform
30
30
31
31
</div>
32
32
33
-
**Vision:** A world where every farm, from smallholders to enterprises, can access transparent, trustworthy, and affordable digital farming intelligence.
33
+
**OpenFarm is an open, modular field intelligence platform that fuses satellite, weather, soil, and time to explain what is happening in a field — and why.**
34
34
35
-
**Mission:** Build and maintain an open, reproducible crop intelligence platform that turns satellite, weather, sensor and field data into actionable insights, with modular workflows for scouting, operations, and analytics — deployable anywhere (self-hosted or hosted).
35
+
-**Vision:** A world where every farm, from smallholders to enterprises, can access transparent, trustworthy, and affordable digital farming intelligence.
36
+
-**Mission:** Build and maintain an open, reproducible crop intelligence platform that turns satellite, weather, soil, and field data into actionable insights — deployable anywhere (self-hosted or hosted).
36
37
37
38
## Why OpenFarm
38
39
- Self-hostable stack with clear service boundaries (Next.js ↔ FastAPI ↔ TiTiler ↔ MinIO ↔ PostGIS)
@@ -52,13 +53,36 @@ Open source self-hostable and reproducible Crop Intelligence Platform
52
53
- Google OAuth credentials (`GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_SECRET`)
53
54
54
55
## Architecture
56
+
57
+
OpenFarm follows a 3-layer strategic architecture:
services/tiler/ → TiTiler COG tile server (shared JWT auth)
59
82
docker-compose.yml → Postgres/PostGIS, Redis, MinIO, API, Celery worker, TiTiler, Web
60
83
```
61
-
**Critical rule:** Next.js talks to Postgres **only** for user upsert during NextAuth auth callback (`apps/web/src/lib/db.ts`). All other data flows through the FastAPI API via `apps/web/src/lib/api.ts`.
84
+
85
+
See [docs/architecture.md](docs/architecture.md) for the full strategic architecture document.
62
86
63
87
## Quick Start (Full Stack via Docker)
64
88
```bash
@@ -143,16 +167,26 @@ ruff format --check .
143
167
- Audit events on key actions (e.g., field_created)
144
168
145
169
## Feature Overview
146
-
-**Auth**: Google OAuth via NextAuth → JWT bridge (`/api/auth/token`)
147
-
-**Orgs & RBAC**: owner/admin/member/viewer with audit logging
148
-
-**Farms & Fields**: draw/upload GeoJSON/KML, area calc, soft delete
149
-
-**Vegetation Monitoring**: NDVI, EVI, SAVI (configurable L factor), NDWI — STAC search → COG → TiTiler tiles → time-series stats, with automatic 24-month historical backfill on field creation and weekly auto-compute
150
-
-**Boundary Detection**: automatic field boundary detection from Sentinel-2 imagery using FTW deep learning model — draw area, review results, accept as fields
151
-
-**Weather Integration**: daily historical + 7-day forecast weather data per field — temperature, precipitation, ET₀, soil moisture/temperature, VPD, GDD, water balance, drought index
0 commit comments