pereyrarg11/drinks

Drinks

App to discover drinks.

About The Project

The main goal of this app is to improve my development skills. The content is about drinks, so the data is taken from TheCocktailDB.

• HomeScreen shows filters like Alcohol, Categories and Ingredients. The content is static for now.

  

• FilterScreen shows drinks filtered by alcohol content, ingredient or category.

  

• DrinkScreen shows drink details like image, tags, ingredients and preparation steps.

  When users click on any tag (Alcoholic and Category types) they are taken to the FilterScreen again to see the drinks filtered by this tag.

  

(back to top)

Built With

• Gradle v1.8
• Java 17
• Kotlin v1.8.10
• Android 14 (API level 34)
• Android Studio Giraffe

(back to top)

Core dependencies

• Jetpack Compose a modern toolkit for building native UI
• Dagger Hilt for dependency injection
• Material Design 3 to met best practices of user interface design
• git-crypt to enable transparent encryption and decryption of files
• Sandwich for handling API responses and exceptions
• Retrofit to configure an HTTP client
• Kotlin Flows for asynchronous data streams
• App Distribution to distribute app versions painless

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

1. Setup commit signature verification
2. Ask to the codeowners for adding you as collaborator on git-crypt config

Installation

1. Clone the repo

   git clone https://github.com/pereyrarg11/Drinks.git

2. Unlock (decrypt) the repo

   git-crypt unlock

(back to top)

Roadmap

• Add FavoritesScreen
• Add offline mode
• Implement In-app updates
• Get HomeScreen content from Firebase Remote Config
• Translate Drink instructions dynamically with DeepL API
• Social log-in through Firebase Auth

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open a Feature request. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some Amazing Feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)

Contact

Gabriel Pereyra Roman

• LinkedIn
• pereyrarg11.com
• [email protected]

Project Link: https://github.com/pereyrarg11/Drinks

(back to top)

Acknowledgments

Resources I find helpful and would like to give credit to.

• TheCocktailDB
• Detekt
• Sandwich
• git-crypt
• JSONView
• JSON Editor Online
• Tinypng
• Android API Levels
• Best-README-Template

(back to top)