feat/demo-running-instructions (#56)

Co-authored-by: Samuel Colvin <[email protected]>
pydantic · Dec 4, 2023 · 4d5ff76 · 4d5ff76
1 parent f0a9cbe
commit 4d5ff76
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/package-lock.json b/package-lock.json
diff --git a/python/demo/README.md b/python/demo/README.md
@@ -1,3 +1,29 @@
 # FastUI Demo
 
 This a simple demo app for FastUI, it's deployed at [fastui-demo.onrender.com](https://fastui-demo.onrender.com).
+
+## Running
+
+To run the demo app, execute the following commands from the FastUI repo root
+
+```bash
+# create a virtual env
+python3.11 -m venv env311
+# activate the env
+. env311/bin/activate
+# install deps
+make install
+# run the demo server
+make dev
+```
+
+Then navigate to [http://localhost:8000](http://localhost:8000)
+
+If you want to run the dev version of the React frontend, run
+
+```bash
+npm install
+npm run dev
+```
+
+This will run at [http://localhost:3000](http://localhost:3000), and connect to the backend running at `localhost:3000`.
diff --git a/python/requirements/all.txt b/python/requirements/all.txt
@@ -1,3 +1,4 @@
 -r ./lint.txt
 -r ./pyproject.txt
 uvicorn[standard]
+httpx