Update README

master
Nikola Forró 6 years ago
parent 4cb09ced6b
commit 9842918dc5

@ -2,14 +2,16 @@
## Project structure
* `api` - Flask application implementing RESTful API for querying/manipulating the database of quotes
* `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)
* `ng-app` - Angular application for browsing quotes
* `apps/quotes` - Angular application for browsing quotes
* `apps/schedule` - Angular application for viewing livestream schedule
* `nginx` - Configuration of NGINX web server
## Deployment
This project consists of 3 container images (`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`, `comments-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:
@ -17,12 +19,12 @@ Easiest way to manage that is using `docker-compose`. Just copy `docker-compose.
docker-compose up -d
```
## API key generation
## Quotes API key generation
API key is needed for `POST`, `PUT` and `DELETE` API methods.
Quotes API key is needed for `POST`, `PUT` and `DELETE` API methods.
If the `api` container is running, the key can be generated like this:
If the `quotes-api` container is running, then the key can be generated like this:
```BASH
docker exec $API_CONTAINER_NAME python generate_api_key.py $USERNAME $EXPIRATION_TIME_IN_SECONDS
docker exec $QUOTES_API_CONTAINER_NAME python generate_api_key.py $USERNAME $EXPIRATION_TIME_IN_SECONDS
```

Loading…
Cancel
Save