Chores/prepare release (#100)

* fix: add env template to version control

* docs: describe just api command

---------

Co-authored-by: sabinem <5292683+sabinem@users.noreply.github.com>

Author: sabinem

config/.env.core.tmpl

@@ -0,0 +1,45 @@
+# Justfile
+OPENAPI_URL=http://localhost:8082/openapi.json
+CONTAINER_MGR=docker
+BUILDKIT_PROGRESS=plain
+COMPOSE_PROFILES=
+
+# S3
+S3_SERVER=http://garage:3900
+S3_PUBLIC_URL=http://localhost:3900
+S3_SIGNING_URL=http://localhost:3900
+S3_BUCKET_NAME=debates
+
+# Backend
+PUBLIC_BACKEND_SERVER=http://backend:8000
+CORS_ORIGINS='["http://localhost:3000","http://localhost:5173","http://127.0.0.1:3000"]'
+
+# Frontend
+ORIGIN=http://localhost:3000
+
+# Solr
+SOLR_URL=http://solr:8983/solr/debates/
+SEARCH_PAGE_SIZE=20
+
+# Redis
+REDIS_URL=redis://redis:6379
+
+# Mongo DB
+MONGO_DB_NAME=debates
+MONGO_MEDIA_COLLECTION=debates
+MONGO_SUBTITLE_COLLECTION=subtitles
+MONGO_SEGMENT_COLLECTION=segments
+MONGO_SPEAKER_COLLECTION=speakers
+
+# Whisper Models: "large-v3"
+HF_MODEL=large-v3
+HF_SPACE_URL=https://katospiegel-odtp-pyannote-whisper.hf.space/
+
+# Files on S3
+S3_MEDIA_PATH="media"
+TYPE_ORIGINAL="original"
+TYPE_TRANSLATION="translation"
+
+# VM Settings
+AUTH_DIR=
+SSL_DIR=

docs/docs/development/development.md

@@ -59,6 +59,14 @@ If you change the solr schema you need to do the following:
 !!! warning
     Don't reset mongodb as all media is registered there.
 
+### API changes
+
+In case of API changes the openapi spec needs to get regenrated for the docs and for the frontend:
+
+```bash title="regenrate api spec in docs and api client for frontend
+just api
+```
+
 ## 5. Documentation
 
 The documentation is built with MkDocs.

docs/docs/installation/core.md

@@ -26,7 +26,7 @@ git clone git@github.com:sdsc-ordes/debates-analytics.git
 cd debates-analytics
 
 # 1. Config for the docker compose
-cp config/.env.tmpl config/.env
+cp config/.env.core.tmpl config/.env
 
 # 2. Config for Application Secrets
 cp config/.env.secrets.tmpl config/.env.secrets