diff --git a/README.md b/README.md index e412124..1122ae7 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,19 @@ ## Project structure -* `quotes-api` - Flask application implementing RESTful API for querying/manipulating the database of quotes -* `comments-api` - Flask application implementing RESTful API for querying the database of Twitch comments -* `cms` - Grav CMS (Content Management System) * `apps/quotes` - Angular application for browsing quotes * `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 ## Deployment -This project consists of 4 container images (`quotes-api`, `comments-api`, `cms` and `nginx`), that depend on each other - they need to run simultaneously and share certain data between themselves. +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. -Easiest way to manage that is using `docker-compose`. Just copy `docker-compose.yaml.example` into `docker-compose.yaml`, make necessary adjustments and fire it all up with: +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: ```BASH docker-compose up -d