coco
89 lines
4.0 KiB
Markdown
89 lines
4.0 KiB
Markdown
<p align="center">
|
|
<img src="https://github.com/shorthouse/CoinWatch/assets/73708076/8beb706b-fdaa-47fe-9230-e28388b6d768"/>
|
|
</p>
|
|
|
|
# CoinWatch
|
|
[](https://github.com/shorthouse/CoinWatch/actions)
|
|
[](https://github.com/shorthouse/CoinWatch/releases)
|
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
[](https://medium.com/@shorthousedev)
|
|
[](https://github.com/shorthouse)
|
|
[](https://pinterest.github.io/ktlint/)
|
|
|
|
**CoinWatch** is a cryptocurrency app providing real-time coin prices, price histories, and market data.
|
|
|
|
The app is built using the latest [Android architecture components](https://developer.android.com/topic/architecture/recommendations) - resulting in a scalable, modularised and testable app.
|
|
|
|
# 📱 Download
|
|
<a href='https://play.google.com/store/apps/details?id=dev.shorthouse.coinwatch&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'>
|
|
<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' height='80'/>
|
|
</a>
|
|
|
|
# ⭐ Features
|
|
- Get a list of real-time prices and price changes of the top cryptocurrencies
|
|
- Analyse coins in detail with animated price history graphs and market stats data
|
|
- Search through thousands of cryptocurrencies by name or symbol
|
|
- Create a personalized list of favourite cryptocurrencies
|
|
|
|
# 🛠 Built With
|
|
- Kotlin
|
|
- Jetpack Compose
|
|
- Retrofit
|
|
- Coil
|
|
- OkHttp
|
|
- Coroutines
|
|
- Flow
|
|
- Hilt
|
|
- ViewModel
|
|
- Timber logging
|
|
- Room
|
|
- Material Design 3
|
|
- Static code analysis using Ktlint
|
|
|
|
# 🧱 Architecture
|
|
The design of CoinWatch follows a few key principles:
|
|
1. Unidirectional Data Flow (UDF) - State flows in one direction, and events that modify the data flow in the opposite direction.
|
|
2. Single Source of Truth (SSOT) - The SSOT is the owner of data, and only the SSOT can modify or mutate it.
|
|
3. Drive UI from immutable data models - App data is contained within persistent data models and drives UI components.
|
|
|
|
A high-level overview of the app's architecture is displayed below. The architecture follows [Google's official architecture guidance](https://developer.android.com/topic/architecture).
|
|
|
|
<p align="center">
|
|
<img src="https://github.com/shorthouse/CoinWatch/assets/73708076/d931301f-80da-4cb7-9824-bdf1d4cdfaa3" width="750">
|
|
</p>
|
|
|
|
# 🧬 Testing
|
|
To facilitate testing of the app, CoinWatch uses the following:
|
|
- JUnit for local tests
|
|
- Jetpack Compose testing APIs for instrumented tests
|
|
- Truth for assertions
|
|
- MockK for mocks
|
|
|
|
|
|
# 🤝 Contributing
|
|
Contributions to the project are welcome and highly encouraged! To get started, please check out the [contributing guidelines](https://github.com/shorthouse/CoinWatch/blob/main/CONTRIBUTING.md).
|
|
|
|
# 📥 Contact
|
|
Do you have ideas to improve the app or a query for the developer?
|
|
|
|
Please get in touch via email - shorthousedev@gmail.com
|
|
|
|
# ❤️ Acknowledgements
|
|
- Coin data provided by [CoinRanking API](https://developers.coinranking.com/api)
|
|
- Empty state images provided by [unDraw](https://undraw.co/illustrations)
|
|
|
|
# 🔖 License
|
|
```
|
|
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
|
|
|
|
https://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.
|
|
```
|