diff --git a/README.md b/README.md new file mode 100644 index 0000000..42ac00a --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# JumpingMindTask + +

+ + + + +[![JumpingMindTask App](https://img.shields.io/badge/JumpingMind✅-APK-red.svg?style=for-the-badge&logo=android)](https://github.com/Miihir79/JumpingMindTask/releases/download/1.0.0/app-debug.apk) + +

+ +This app was build on top of api provided by Punk API, it displays list of beers and shows it details, you can even save these beers for future use. + +### Screenshots + + + +
List of Beers + Liked Beers + Beer Details +
+ +### Demo + +https://user-images.githubusercontent.com/66465511/214589829-b3a2e05f-f4cc-40c3-869a-dc88fbed31b4.mp4 + + + +### Libraries used + - Gson + - intuit sdp & ssp + - Retrofit + - shredpreferences + - room + - paging + - shimmerview + - material tap target prompt + - splashscreen API + +### ***Download the app from here👇*** + +[![JumpingMindTask App](https://img.shields.io/badge/JumpingMind✅-APK-red.svg?style=for-the-badge&logo=android)](https://github.com/Miihir79/JumpingMindTask/releases/download/1.0.0/app-debug.apk) + +## Package Structure + + com.mihir.jumpingmindtask # Root Package + . + ├── model # Model data classes + | + ├── database # RoomDB and TypeConverters + | + ├── network # AppObjectController, Retrofit, network service + | + ├── ui # UI/View layer + | ├── adapter # Adapter, ViewHolder + | └── screens # Activity, Fragments + | + └── viewmodel # ViewModels + + +## How to contribute? +### What do you need to get started? +#### Latest version of android studio and basic android and googling skills will get you going. +All contributions are welcomed, Properly describe changes made and attach supporting ScreenShots in the PR. For major changes first open an issue. + +## Author +Initial work: ***Mihir Shah***
+This project was created as an interview process assignment.