You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
1.2 KiB

7 years ago
# ladylilia.com
## Project structure
6 years ago
* `apps/quotes` - Angular application for browsing quotes
* `apps/schedule` - Angular application for viewing livestream schedule
6 years ago
* `apps/twitch-logs` - Angular application for browsing Twitch chat logs
* `cms` - Grav CMS (Content Management System)
7 years ago
* `nginx` - Configuration of NGINX web server
6 years ago
* `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
7 years ago
## Deployment
6 years ago
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.
7 years ago
6 years ago
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:
7 years ago
```BASH
docker-compose up -d
```
6 years ago
## Quotes API key generation
7 years ago
6 years ago
Quotes API key is needed for `POST`, `PUT` and `DELETE` API methods.
7 years ago
6 years ago
If the `quotes-api` container is running, then the key can be generated like this:
7 years ago
```BASH
6 years ago
docker exec $QUOTES_API_CONTAINER_NAME python generate_api_key.py $USERNAME $EXPIRATION_TIME_IN_SECONDS
7 years ago
```