MSU576 commited on
Commit
79c3d58
Β·
verified Β·
1 Parent(s): 310c582

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -0
README.md CHANGED
@@ -6,5 +6,28 @@ colorTo: green
6
  sdk: docker
7
  pinned: false
8
  ---
 
9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
6
  sdk: docker
7
  pinned: false
8
  ---
9
+ # GeoMate V3 β€” FastAPI + React (Docker) β€” Deployable on Hugging Face Spaces
10
 
11
+ ## Quick overview
12
+ This repository contains a deployable FastAPI backend and React frontend for GeoMate V3 (geotechnical assistant). The Dockerfile builds the React frontend and runs the FastAPI server.
13
+
14
+ ## Secrets (set in HF Space Settings β†’ Secrets)
15
+ - `GROQ_API_KEY` β€” Groq API key (optional, for RAG)
16
+ - `SERVICE_ACCOUNT` β€” Earth Engine service account email (optional)
17
+ - `EARTH_ENGINE_KEY` β€” Earth Engine service account JSON (paste entire JSON)
18
+
19
+ If secrets are not present, the app runs with reduced functionality and clear messages.
20
+
21
+ ## Deploy to Hugging Face (Docker)
22
+ 1. Create a new Space on Hugging Face: https://huggingface.co/new-space
23
+ - Choose **Docker** as the SDK.
24
+ 2. Upload or push this repository to the Space.
25
+ 3. In Space settings β†’ Secrets, add `GROQ_API_KEY`, `SERVICE_ACCOUNT`, `EARTH_ENGINE_KEY` (if using EE).
26
+ 4. Wait for the build β€” HF will run the Dockerfile and start the app.
27
+ 5. The app will be available at `https://<your-space>.hf.space`.
28
+
29
+ ## Run locally with Docker
30
+ ```bash
31
+ docker build -t geomate-v3 .
32
+ docker run -p 7860:7860 -e GROQ_API_KEY="..." -e SERVICE_ACCOUNT="..." -e EARTH_ENGINE_KEY="$(cat key.json)" geomate-v3
33
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference