From ce9be0b223bde5f4c448fbf3291d5cf4e0ec2e71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikola=20Forr=C3=B3?= Date: Fri, 24 Aug 2018 11:17:36 +0200 Subject: [PATCH] Update readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1122ae7..e2195e9 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,20 @@ ## Project structure +* `apps/gifted-subs` - Angular application for browsing gifted subs * `apps/quotes` - Angular application for browsing quotes +* `apps/regular-subs` - Angular application for browsing regular subs * `apps/schedule` - Angular application for viewing livestream schedule * `apps/twitch-logs` - Angular application for browsing Twitch chat logs * `cms` - Grav CMS (Content Management System) * `nginx` - Configuration of NGINX web server * `quotes-api` - Flask application implementing RESTful API for querying/manipulating the database of quotes * `twitch-cache-api` - Flask application implementing RESTful API for querying the Twitch cache +* `twitch-subs-api` - Flask application implementing RESTful API for querying the database of Twitch subscriptions ## Deployment -This project consists of 4 container images (`quotes-api`, `twitch-cache-api`, `cms` and `nginx`), that depend on each other - they need to run simultaneously and share certain data between themselves. +This project consists of 5 container images (`quotes-api`, `twitch-cache-api`, `twitch-subs-api`, `cms` and `nginx`), that depend on each other - they need to run simultaneously and share certain data between themselves. Best way to manage that is with `docker-compose`. Just copy `docker-compose.yaml.example` into `docker-compose.yaml`, make necessary adjustments and fire it all up with: @@ -29,3 +32,7 @@ If the `quotes-api` container is running, then the key can be generated like thi ```BASH docker exec $QUOTES_API_CONTAINER_NAME python generate_api_key.py $USERNAME $EXPIRATION_TIME_IN_SECONDS ``` + +## Twitch subs API key generation + +Same as above, just replace `quotes-api` with `twitch-subs-api`.