summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYurenHao0426 <blackhao0426@gmail.com>2026-02-14 02:51:28 +0000
committerYurenHao0426 <blackhao0426@gmail.com>2026-02-14 02:51:28 +0000
commitded75a5c19ad4aa8dc832fc4c138b68093e22ee8 (patch)
tree0027a6aca46136943c50dedc88ac53128a0474d6 /README.md
parent9170f7dba01c076f1ac1367549095fd69524ba9d (diff)
Add README with startup instructions and add google-genai dependency
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index 79929f9..fb44e25 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# flexibleContextPlatform \ No newline at end of file
+# ContextFlow
+
+## Quick Start
+
+### Backend
+
+```bash
+cd backend
+uv run --with-requirements requirements.txt uvicorn app.main:app --host 0.0.0.0 --port 8000
+```
+
+### Frontend
+
+```bash
+cd frontend
+npm install # first time only
+npx vite --port 5174
+```
+
+### Nginx
+
+The production domain `contextflow.blackhao.com` reverse-proxies to `127.0.0.1:8000`. \ No newline at end of file