Finally find the coffee variant that everybody in the office enjoys!
Note: This project is not intended to be run outside of safe environments!
python3.11pipenv
To run the web application locally, you need to install the dependencies via pipenv install first.
Afterwards, you can start the application with gunicorn by running ./start.sh.
The server will start listening to port 5000.
A containerized setup is also available through docker compose up.
The service will be available on port 443.
In order to use TLS/SSL, a proper key pair should be placed in ssl/ssl.{key,crt}.
If no such key pair is present, the provided test key pair (ssl/test.{key,crt}) will be used by start.sh as a fallback.
That is sufficient for development/testing purposes on localhost, but obviously not for an actual deployment.
A simple web UI is available on the default path.
Give a personal rating for one of the available coffee variants.
This endpoint requires the following values to be set:
variant(string): The coffee variant you're voting for.name(string): Your name. There can only be a single vote given per name.vote(integer): Your vote.0is a dislike,1is a like.
Example use with HTTPie:
https --verify=no --form https://localhost/api/vote name=Max variant=Corsini vote=1Create a new coffee variant in the system.
The endpoint requires the following values to be set:
name(string): The name for the new coffee variant.token(string): The admin token for authorization.
Example use with HTTPie:
https --verify=no --form https://localhost/api/variants name=Corsini token=e903828a-84f8-4d30-a0c5-e7fd942ecd78Note:
The expected for the admin token value in the backend can be set through the ADMIN_TOKEN config item.
If set during startup, it will be read from the COFFEE_ADMIN_TOKEN environment variable.
If no explicit value is set, a randomized token will be created during startup and printed to stdout.
Exports all votes in a simple JSON format. Example export:
{
"Corsini": {
"Max": "+",
"Tomasz": "-"
},
"BadCoffee": {
"Max": "-"
}
}