Skip to content

armgit / meet

Public Imported from GitHub
0

Open source video conferencing app powered by LiveKit. Built with Django and React.

📝(summary) add minimal README for dev experience

lebaudantoinec2e692797892
diff --git a/src/summary/README.md b/src/summary/README.md
new file mode 100644
index 00000000..3cea22ce
--- /dev/null
+++ b/src/summary/README.md
@@ -0,0 +1,32 @@
+# Experimental Stack
+
+This is an experimental part of the stack. It currently lacks proper observability, unit tests, and other production-grade features. This serves as the base for AI features in Visio.
+
+## Usage
+
+From the root of the project:
+
+```sh
+make bootstrap
+```
+
+Configure your env values in `env.d/summary` to properly set up WhisperX and the LLM API you will call.
+
+```sh
+make run
+```
+
+When the stack is up, configure the MinIO webhook
+*(TODO: add this step to `make bootstrap`)*
+
+```sh
+make minio-webhook-setup
+```
+
+If you want to develop on the Celery workers with hot reloading, run:
+
+```sh
+docker compose watch celery-summary-transcribe celery-summary-summarize
+```
+
+Celery workers will hot reload on any change.