coco
78 lines
2.8 KiB
Markdown
78 lines
2.8 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<img src="/screenshots/banner.png"/>
|
|
<br>
|
|
Mojito
|
|
<br>
|
|
</h1>
|
|
|
|
<p align="center">Mojito* is a cocktail manual, which contains recipes, images, and so on.</p>
|
|
|
|
_*Mojito: an alcoholic drink made with rum, lime juice, sugar, and mint._
|
|
|
|
## Screenshots
|
|
|
|
<p>
|
|
<img src="/screenshots/explore.png" width="32%"/>
|
|
<img src="/screenshots/explore-six-base-liquors.png" width="32%"/>
|
|
<img src="/screenshots/explore-iba-official-cocktail-list.png" width="32%"/>
|
|
</p>
|
|
|
|
<p>
|
|
<img src="/screenshots/collections.png" width="32%"/>
|
|
<img src="/screenshots/search.png" width="32%"/>
|
|
<img src="/screenshots/recipe.png" width="32%"/>
|
|
</p>
|
|
|
|
## Download
|
|
|
|
<a href='https://play.google.com/store/apps/details?id=com.kiwi.cocktail'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=240/></a>
|
|
|
|
## Development
|
|
|
|
+ 100% [Kotlin](https://kotlinlang.org/)
|
|
+ UIs are completely written in [Compose](https://developer.android.com/jetpack/compose)
|
|
+ Follow latest official [app architecture guide](https://developer.android.com/jetpack/guide)
|
|
+ Follow [Material3](https://m3.material.io/) (Material You) Design Guide
|
|
+ Support dark mode
|
|
+ Support dynamic colors (Require Android 12 or higher)
|
|
+ Use [version catalog](https://docs.gradle.org/current/userguide/platforms.html) to share dependency versions
|
|
+ Use [ktlint](https://github.com/pinterest/ktlint) to check code style
|
|
|
|
## API
|
|
|
|
This project uses [TheCocktailDB](https://www.thecocktaildb.com/) to fetch cocktail data.
|
|
|
|
## Firebase (optional)
|
|
|
|
This project use Firebase for tracking screen view and recording log.
|
|
|
|
If you don't need those features, just ignore it. Otherwise, put your `google-services.json` in `app/`.
|
|
|
|
## Credits
|
|
|
|
+ App logo and easter egg images are designed by .. (aka Shih).
|
|
+ Imagery is sourced from [Unsplash](https://unsplash.com/).
|
|
+ [59196-drink.json](common-ui-resources/src/main/assets/animations/59196-drink.json) animation is made by [Atmaja Art](https://lottiefiles.com/atmaja.art) from [LottieFiles](https://lottiefiles.com/59196-drink).
|
|
|
|
## Special Thanks
|
|
|
|
Thanks [Tivi](https://github.com/chrisbanes/tivi) for providing lots of coding sample to build a project.
|
|
|
|
## License
|
|
|
|
```
|
|
Copyright 2022 Kiwi Lin (Chih-Wei Lin)
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
``` |