android-weather-demo-app/README.md

37 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2020-03-09 18:23:13 +05:00
# android-weather-demo
![android-weather-demo-logo](https://github.com/bernd32/android-weather-demo-app/blob/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png)
2020-03-09 00:42:51 +05:00
## Description
2020-03-09 18:23:13 +05:00
A simple weather app made for testing and practicing Retrofit and RxJava. It uses a free demo version of OpenWeather API, hence "demo" in title. By the way, I don't recommend to use this project as your reference since this is one of my first Android apps so I bet it's too poorly designed to be a reference project. But if you still want to of course I don't mind :)
## Features
- Showing weather and forecast for current location
- Creating a list of custom locations, showing its weather and forecast
2020-03-09 00:42:51 +05:00
## Screenshots
<details>
<summary>Click me</summary>
<p>
2020-03-09 18:23:13 +05:00
![app-screenshot](https://github.com/bernd32/android-weather-demo-app/blob/master/screenshots/Screenshot_1583691827.png?raw=true)
![app-screenshot](https://github.com/bernd32/android-weather-demo-app/blob/master/screenshots/Screenshot_1583691830.png?raw=true)
2020-03-09 00:42:51 +05:00
2020-03-09 18:23:13 +05:00
![app-screenshot](https://github.com/bernd32/android-weather-demo-app/blob/master/screenshots/Screenshot_1583691851.png?raw=true)
![app-screenshot](https://github.com/bernd32/android-weather-demo-app/blob/master/screenshots/Screenshot_1583691857.png?raw=true)
2020-03-09 00:42:51 +05:00
</p>
</details>
## How to use
2020-03-09 18:23:13 +05:00
Download and install `.apk` file from [the latest release](https://github.com/bernd32/android-weather-demo-app/releases).
2020-03-09 18:28:15 +05:00
To build the project from source files, you have to obtain API key from here: https://openweathermap.org/api and then add it to `Constants.java` file.
2020-03-09 00:42:51 +05:00
## About me
I'm a beginner to programming and (at least at this point of time) developing applications for Android is just one of my hobbies. This application is my first training project, so the source code is pretty dirty, but I tried to follow the main principles of MVP architectural pattern.
If you have any questions please feel free to contact me at <a href=mailto:fallentides@outlook.com>fallentides@outlook.com</a>. Cheers!
## License
2020-03-09 18:23:13 +05:00
android-weather-demo is licensed under the Apache License, Version 2.0. See `LICENSE.md` for more details.