docs: add README and update .env example (#78)

leaphy-robotics · Nov 16, 2024 · 693650d · 693650d
1 parent 4edb0c0
commit 693650d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -1 +1,2 @@
 ARDUINO_CLI_PATH=/path/to/arduino-cli
+groq_api_key=gsk_blablabla
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# Leaphy webbased backend
+
+## Running
+Make a copy of `.env.example` named `.env`.
+Fill in the path to `arduino-cli` and request an API key at https://console.groq.com/keys .
+
+Install `requirements.txt` and run with:
+```bash
+python -m uvicorn --host 0.0.0.0 --port 5000 main:app
+```