<div align="center">
  <img width="500" src="./docs/assets/github-preview.png">
  <br><br>
</div>

[![Gradle-Build](https://github.com/bircni/ParkenUlmAndroid/actions/workflows/gradle.yml/badge.svg)](https://github.com/bircni/ParkenUlmAndroid/actions/workflows/gradle.yml)
[![Installs](https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Ddevelopment.parkenulm%26l%3DGoogle%2520Play%2520Installs%26m%3D%24installs)](https://play.google.com/store/apps/details?id=development.parkenulm)
[![Release](https://img.shields.io/github/v/release/bircni/ParkenUlmAndroid?include_prereleases)]( https://github.com/bircni/ParkenUlmAndroid/releases)
![GitHub all releases](https://img.shields.io/github/downloads/bircni/ParkenUlmAndroid/total)

# ParkenUlm - Android App

<div align="center">
<a href='https://play.google.com/store/apps/details?id=development.parkenulm'><img alt='Get it on Google Play' src='./docs/assets/badges/badge_googleplay.png' height='80px'/></a>
<a href='https://apt.izzysoft.de/fdroid/index/apk/development.parkenulm'><img alt='Get it on IzzyOnDroid' src='./docs/assets/badges/badge_izzyondroid.png' height='80px'/></a>
<a href='https://github.com/bircni/ParkenUlmAndroid/releases/latest'><img alt='Get it on Github' src='./docs/assets/badges/badge_github.png' height='80px'/></a>
</div>

## About The Project

A small Android App to see the current usage of the parking garages in Ulm, Germany.  
The data is provided by the city of Ulm.  

- supports dark mode
- uses Internet connection only to fetch data
- supports Android N (API level 25) and higher

## Screenshots

<div align="center">
<img src="./docs/assets/screenshots/Pixel 6/ParkenUlm-dark-Pixel6.png" width="300"  />
<img style="margin-left: 100px" src="./docs/assets/screenshots/Pixel 6/ParkenUlm-bright-Pixel6.png" width="300"/>
</div>
<br>
<details>
<summary>Pixel 4</summary>
<br>
<div align="center">
<img src="./docs/assets/screenshots/Pixel%204/ParkenUlm-dark-Pixel4.png" width="300"  />
<img style="margin-left: 100px" src="./docs/assets/screenshots/Pixel%204/ParkenUlm-bright-Pixel4.png" width="300"  />
</div>
</details>

## Languages

The App is currently available in the following languages:

- German
- English

Let's support more languages [Poeditor - Translator](https://poeditor.com/join/project/03mDIobjYS)

## Prerequisites

- [Android Studio](https://developer.android.com/studio)
- Android SDK
- Android N (API 24) or higher

## Installation

Feel free to download the latest release from one of the sources above.  
If you want to build it yourself, follow the steps below.

1. Clone the repo

   ```sh
   git clone https://github.com/bircni/ParkenUlmAndroid.git
   ```

2. Open in Android Studio
3. Run on emulator or device

## Dependencies

- [AppCompat](https://developer.android.com/jetpack/androidx/releases/appcompat)
- [Material](https://material.io/develop/android/docs/getting-started/)
- [ConstraintLayout](https://developer.android.com/jetpack/androidx/releases/constraintlayout)
- [Jsoup](https://jsoup.org/)
- [Paper](https://github.com/pilgr/Paper)
- [SwipeRefreshLayout](https://developer.android.com/jetpack/androidx/releases/swiperefreshlayout)

## Contributing

If you want to contribute - open an issue or a pull request.

1. Fork the Project
2. Use understandable commit messages
3. Open a Pull Request

## License

Distributed under the GNU General Public License v3.0. See `LICENSE` for more information.

## Thanks to

- [@Parken in Ulm](https://www.parken-in-ulm.de/) for the data
- [@dj82atwork](https://github.com/dj82atwork) for the icon
- [@IzzySoft](https://github.com/IzzySoft) for deploying the app on IzzyOnDroid
- [@AlexandreSanlim](https://github.com/alexandresanlim) for the website template
