diff --git a/ReadMe.md b/ReadMe.md index 236a965..a2335c9 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -1 +1,109 @@ -# Krypto \ No newline at end of file + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + +![](https://img.shields.io/badge/Personal_Project-blue) + +# Krypto + +> Monitor various crypto assets and perform mock purchases to test your crypto skills from the safety and comfort of your phone. + +## Technologies + +> Native application developed using the **Kotlin** programming language. + +Below are some of the key android concepts used/applied in this project: + +- Clean Architecture +- Jetpack compose +- Feature multi-modularization +- Room Database +- Retrofit / OkHttp +- Dagger-Hilt +- Shared preferences +- etc + +### Project Tasks +Each feature is divided according to 3 layers; presentation, domain, data + +- [ ] Home Feature (Presentation) +- [ ] Home Feature (Domain) +- [ ] Home Feature (Data) +- [ ] Transaction Feature (Presentation) +- [ ] Transaction Feature (Domain) +- [ ] Transaction Feature (Data) +- [ ] Coin List Feature (Presentation) +- [ ] Coin List Feature (Domain) +- [ ] Coin List Feature (Data) +- [ ] Coin Details Feature (Presentation) +- [ ] Coin Details Feature (Domain) +- [ ] Coin Details Feature (Data) +- [ ] Setting Feature (Presentation) +- [ ] Setting Feature (Domain) +- [ ] Setting Feature (Data) + +## UI Designs + +### Light +Splash screen Home screen Coin list screen +Coin details screen Choose asset screen Buy - Sell screen +Settings screen App info screen Loading example screen + +### Dark +Splash screen Home screen Coin list screen +Coin details screen Choose asset screen Buy - Sell screen +Settings screen App info screen Loading example screen + +## Getting Started + +To get a local copy up and running follow these simple example steps. + +```bash +git clone https://github.com/RyanKoech/android-krypto.git +``` + +### Prerequisites +Installed Android Studio or Any other android development IDEs and their respective dependencies. + +## 🤝 Contributing + +Contributions, issues, and feature requests are welcome! +You can pick a thing to do from the tasks list provided above and work on it. + +Feel free to check the [issues page](../../issues/) or [discussions page](../../discussions). + +## Show your support + +Give a ⭐ if you like this project! + +## Acknowledgments + +- [Brian Njogu](https://brayo.co/) - original ideator of Krypto and developer of the react native version + +## 📝 License + +This project is [MIT](./MIT.md) licensed. + + + + +[contributors-shield]: https://img.shields.io/github/contributors/RyanKoech/android-krypto.svg?style=for-the-badge +[contributors-url]: https://github.com/RyanKoech/android-krypto/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/RyanKoech/android-krypto.svg?style=for-the-badge +[forks-url]: https://github.com/RyanKoech/android-krypto/network/members +[stars-shield]: https://img.shields.io/github/stars/RyanKoech/android-krypto.svg?style=for-the-badge +[stars-url]: https://github.com/RyanKoech/android-krypto/stargazers +[issues-shield]: https://img.shields.io/github/issues/RyanKoech/android-krypto.svg?style=for-the-badge +[issues-url]: https://github.com/RyanKoech/android-krypto/issues +[license-shield]: https://img.shields.io/github/license/RyanKoech/android-krypto.svg?style=for-the-badge +[license-url]: https://github.com/RyanKoech/android-krypto/blob/master/LICENSE diff --git a/images/design_dark_app_info.jpg b/images/design_dark_app_info.jpg new file mode 100644 index 0000000..10c12fb Binary files /dev/null and b/images/design_dark_app_info.jpg differ diff --git a/images/design_dark_buy_sell.jpg b/images/design_dark_buy_sell.jpg new file mode 100644 index 0000000..3c63364 Binary files /dev/null and b/images/design_dark_buy_sell.jpg differ diff --git a/images/design_dark_choose_asset.jpg b/images/design_dark_choose_asset.jpg new file mode 100644 index 0000000..8b2e91d Binary files /dev/null and b/images/design_dark_choose_asset.jpg differ diff --git a/images/design_dark_coin_details.jpg b/images/design_dark_coin_details.jpg new file mode 100644 index 0000000..0bf4ccd Binary files /dev/null and b/images/design_dark_coin_details.jpg differ diff --git a/images/design_dark_coin_list.jpg b/images/design_dark_coin_list.jpg new file mode 100644 index 0000000..09d44d4 Binary files /dev/null and b/images/design_dark_coin_list.jpg differ diff --git a/images/design_dark_home.jpg b/images/design_dark_home.jpg new file mode 100644 index 0000000..26be705 Binary files /dev/null and b/images/design_dark_home.jpg differ diff --git a/images/design_dark_loading_example.jpg b/images/design_dark_loading_example.jpg new file mode 100644 index 0000000..5f5d6d4 Binary files /dev/null and b/images/design_dark_loading_example.jpg differ diff --git a/images/design_dark_settings.jpg b/images/design_dark_settings.jpg new file mode 100644 index 0000000..9867fbd Binary files /dev/null and b/images/design_dark_settings.jpg differ diff --git a/images/design_dark_splash.jpg b/images/design_dark_splash.jpg new file mode 100644 index 0000000..8989e95 Binary files /dev/null and b/images/design_dark_splash.jpg differ diff --git a/images/design_light_app_info.jpg b/images/design_light_app_info.jpg new file mode 100644 index 0000000..2eb4ddd Binary files /dev/null and b/images/design_light_app_info.jpg differ diff --git a/images/design_light_buy_sell.jpg b/images/design_light_buy_sell.jpg new file mode 100644 index 0000000..ab10607 Binary files /dev/null and b/images/design_light_buy_sell.jpg differ diff --git a/images/design_light_choose_asset.jpg b/images/design_light_choose_asset.jpg new file mode 100644 index 0000000..6659232 Binary files /dev/null and b/images/design_light_choose_asset.jpg differ diff --git a/images/design_light_coin_details.jpg b/images/design_light_coin_details.jpg new file mode 100644 index 0000000..94cdf9f Binary files /dev/null and b/images/design_light_coin_details.jpg differ diff --git a/images/design_light_coin_list.jpg b/images/design_light_coin_list.jpg new file mode 100644 index 0000000..b646051 Binary files /dev/null and b/images/design_light_coin_list.jpg differ diff --git a/images/design_light_home.jpg b/images/design_light_home.jpg new file mode 100644 index 0000000..bb2cd65 Binary files /dev/null and b/images/design_light_home.jpg differ diff --git a/images/design_light_loading_example.jpg b/images/design_light_loading_example.jpg new file mode 100644 index 0000000..d2bd6b2 Binary files /dev/null and b/images/design_light_loading_example.jpg differ diff --git a/images/design_light_settings.jpg b/images/design_light_settings.jpg new file mode 100644 index 0000000..e8e33c7 Binary files /dev/null and b/images/design_light_settings.jpg differ