aboutsummaryrefslogtreecommitdiffstats
path: root/demo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'demo/README.md')
-rw-r--r--demo/README.md12
1 files changed, 12 insertions, 0 deletions
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
+```