caFICteria-aaS/README.md

32 lines
2.1 KiB
Markdown

# caFICtería-aaS
<img src="web/main/static/main/img/logo.svg" alt="Project logo" width=200/>
| Container | Build status |
| --------- | ------------ |
| **Web** | [![caficteria-web on Quay](https://quay.io/repository/peprolinbot/caficteria-web/status "caficteria-web on Quay")](https://quay.io/repository/peprolinbot/caficteria-web) |
| **Bot** | [![caficteria-bot on Quay](https://quay.io/repository/peprolinbot/caficteria-bot/status "caficteria-bot on Quay")](https://quay.io/repository/peprolinbot/caficteria-bot) |
Welcome to caFICtería-aaS, an **unofficial** page for the _Facultade de Informática da Coruña_ (FIC)'s cafeteria. Here, you can easily check the **daily menu** offerings (scraped from Telegram), enjoy memorable **quotes from our beloved waiter Lázaro**, and more!
## 🐳 Install with Docker
If you want to host your own instance of caFICtería-aaS, it is as easy as a few docker containers. You can use the `docker-compose.yml` file at the root of this repo. You know: `docker-compose up -d`.
If you want to get the history of menus since 2018 you can do `docker-compose exec bot python3 get_history.py` (I guess you can skip this if you don't love data 😔).
If you want to access the Django admin interface, you need to create a user with `docker-compose exec web python3 manage.py createsuperuser`
### 🔧 Environment Variables
You can check each folder (`bot` and `web`) and look at the `README.md` for information about the individual parts of the project and evironment variables.
## ⚠️ Disclaimer
This project is not endorsed by, directly affiliated with, maintained by, sponsored by or in any way officially related with _Universidade da Coruña_ or _Facultade de Informática da Coruña_. I'm just a student there 😅.
## ❤️ Credits
- Logo
- Base cup by [OpenClipart-Vectors](https://pixabay.com/users/openclipart-vectors-30363) from Pixabay ([here](https://pixabay.com/vectors/coffee-cup-silhouette-steam-tea-158980/))
- The original FIC logo is the property of _Universidade da Coruña_ and _Facultade de Informática da Coruña_.