aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan Tuomi <jan@jantuomi.fi>2025-05-03 10:39:04 +0300
committerJan Tuomi <jan@jantuomi.fi>2025-05-03 10:39:04 +0300
commitad78ced520ff113d0e2b5b451eb65d13322f292e (patch)
tree72bcbe7f42b2b599b80e8929f54ed599ef6dc876
parent20469145fe715884e343621233b202f4c5185c75 (diff)
Add demo app README
-rw-r--r--demo/.gitignore1
-rw-r--r--demo/README.md12
2 files changed, 13 insertions, 0 deletions
diff --git a/demo/.gitignore b/demo/.gitignore
new file mode 100644
index 0000000..17186c7
--- /dev/null
+++ b/demo/.gitignore
@@ -0,0 +1 @@
+db_data
diff --git a/demo/README.md b/demo/README.md
new file mode 100644
index 0000000..e1b805c
--- /dev/null
+++ b/demo/README.md
@@ -0,0 +1,12 @@
+# Demo chat app
+
+This is a demo chat app built using AutereDB, Python and Flask.
+
+## Installation
+
+Get a Python 3 environment running on your machine (pref. with virtualenv). Then:
+
+```bash
+pip install -r requirements.txt
+DB_DIR=${PWD}/db_data BASE_URL=localhost:8000 python -m flask --app app --debug run -p 8000
+```