Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Lastaapps/menza
This Android app shows dish menus for CTU cafeterias from agata.suz.cvut.cz web in much more pleasant and usable way for phones. It shows today and week menu, opening hours, contacts, announcements and address for all the canteens. It supports dark mode and Material You including Android 12 dynamic theming.
https://github.com/Lastaapps/menza
android android-app ctu ctu-fit jetpack kotlin kotlin-android material-ui
Last synced: 9 days ago
JSON representation
This Android app shows dish menus for CTU cafeterias from agata.suz.cvut.cz web in much more pleasant and usable way for phones. It shows today and week menu, opening hours, contacts, announcements and address for all the canteens. It supports dark mode and Material You including Android 12 dynamic theming.
- Host: GitHub
- URL: https://github.com/Lastaapps/menza
- Owner: Lastaapps
- License: gpl-3.0
- Created: 2022-01-23T13:55:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T09:27:19.000Z (about 1 month ago)
- Last Synced: 2024-05-21T22:34:42.837Z (about 1 month ago)
- Topics: android, android-app, ctu, ctu-fit, jetpack, kotlin, kotlin-android, material-ui
- Language: Kotlin
- Homepage:
- Size: 11.2 MB
- Stars: 40
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- Material-You-app-list - Menza
README
# CTU Menza
This Android app shows dish menus for CTU cafeterias from the [agata.suz.cvut.cz](https://agata.suz.cvut.cz/)
and [studentcatering.cz](http://studentcatering.cz/jidelni-listek/) websites
in a much more pleasant and usable way for phones.
It shows today's and this week's menu, opening hours, contacts, announcements and addresses for all canteens.
Core parts are written in Kotlin Multiplatform, support for JVM target can be added right away. Other targets require more work (non-JVM web scraping library required), but it still may be manageable for somebody to port this codebase to native or js platforms.
See **contributing** below.
##### What does 'Menza' mean?
Menza is the Czech word for school cafeteria.
[
](https://play.google.com/store/apps/details?id=cz.lastaapps.menza&utm_source=github)[
](https://f-droid.org/packages/cz.lastaapps.menza)
## Related projects
- [Menza CLI (LastaApps)](https://github.com/Lastaapps/menza-cli)
- [Menza BE (LastaApps)](https://github.com/Lastaapps/menza-backend)
## Libraries
- AndroidX (Compose, ...)
- ArrowKt
- Decompose
- SQLDelight
- Koin
- Coil-kt
- Ktor
- And more
The core of the all in written in Kotlin Multiplatform!
## Features
- Today's menu + dish details
- This week's menu
- Menza opening hours, contacts, announcements and addresses
## User experience
- Dark theme
- Many themes along with support for Android 12 Material You dynamic theming
- Images download switch on metered networks (~0.7 MB per image)
- Image caching
- No private data collection
- Proper landscape mode and large screen device support
## Screenshots
#### Contributing and project structure
Feel free to contribute, but **contact me before please**, so we don't do the same thing twice.
If you are new to Kotlin/Android, you can write the code yourself,
and I'll adjust it to the rules below.
So it's fine to write it *wrong* (different),
but don't be surprised when I rewrite it.
Most of the modules are multiplatform, and you should respect it.
That means write as much code as possible into the common code and
if there is no (nice) way to implement feature in a multiplatform manner,
this is the time when you can use platform specific package.
Even in that case put at least an interface into the common code
and tie it using DI (preferred over `expected`/`actual` keywords).
The whole app tries to respect clean architecture principles
and MVVM architecture. There is also domain layer presented (use cases).
The whole app is tied together using DI.
##### Structure
- `api/core` - core classes for network communication, store, synchronization, ...
- `api/agata`, `api/buffet` - implementation for individual canteen provider
- `api/main` - packs all the providers into one interface, contains related business logic
- `app` - only UI related code, purely Android (for now)
- `features` - stores all the UI code
- `root` - decides if the user is already logged in
- `starting` - stores setup related code
- `main` - holds main user interface (after login), drawer, top/bottom bar, core navigation
- `today` - the main screen, shows today canteen offering
- `week` - shows week canteen offering
- `info` - shows canteen info
- `panels` - panels for the today screen (rate us, report a crash, what's new, ...)
- `settings` - self-explanatory, includes about screen
- `others` - privacy policy, library notices, ošťurák, ...
- `core` - holds main shared domain logic and templates
- `Outcome` - like Rust's `Result`, success or `DomainError`.
all the functions that can fail should return `Outcome`.
- `UseCase` - base usecase class
- `BaseViewmodel` - parent of all the ViewModels
- `lastaapps` - my legacy common shared code (+ crash reporting)
##### Other modules are **deprecated** and should **not** be used/edited
Namely, modules `entity`, `html-parser`, `scraping` and `storage`.
They were used by the first version of menza and are kept for future in case
I lost access to the API.
#### Data sources
Most of the data is obtained from the official Agata API, see the documentation [here](https://agata.suz.cvut.cz/jidelnicky/JAPIV2/JAPI-popis.html).
To get your API key, please contact the IT center and don't steal mine, they will be more than happy to give you one.
To get FS and FEL buffet data I do scrape their webpages/hardcode info.
## License
Menza is licensed under the `GNU GPL v3.0` license.