https://github.com/telekom/citykey-android
The CityKey Android App. Citykey is an urban living companion designed to enhance the experience of residents and visitors in German cities.
https://github.com/telekom/citykey-android
android android-app citykey deutsche-telekom internet-of-things iot iot-platform kotlin open-source open-source-app smart-city t-mobile telekom
Last synced: 10 months ago
JSON representation
The CityKey Android App. Citykey is an urban living companion designed to enhance the experience of residents and visitors in German cities.
- Host: GitHub
- URL: https://github.com/telekom/citykey-android
- Owner: telekom
- License: apache-2.0
- Created: 2024-11-07T10:03:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-13T09:09:42.000Z (about 1 year ago)
- Last Synced: 2025-08-28T23:09:56.795Z (10 months ago)
- Topics: android, android-app, citykey, deutsche-telekom, internet-of-things, iot, iot-platform, kotlin, open-source, open-source-app, smart-city, t-mobile, telekom
- Language: Kotlin
- Homepage: https://citykey.app/index-en
- Size: 33.4 MB
- Stars: 2
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Android App of Citykey
[](https://opensource.org/license/apache-2-0)
[](https://scorecard.dev/viewer/?uri=github.com/telekom/CityKey-Android/badge)
[](https://api.reuse.software/info/github.com/telekom/CityKey-android)
[](https://pinterest.github.io/ktlint/)
[](https://github.com/telekom/CityKey-Android/actions/workflows/continuous-integration.yml)
## Overview
Citykey is an urban living companion developed by [Deutsche Telekom AG](https://www.telekom.com/de),
designed to enhance the experience of residents and visitors in German cities. The app provides easy
access to local services, events, and transportation information, making it a must-have tool for
navigating urban environments. It is the digital way to access the citizen services.
Please [visit the website](https://citykey.app) for more information!
## Want to try out?
Citykey app is free for downloading available on the PlayStore
## Features
- **Garbage collection calendar:🚛**:
- Distinguish between different types of garbage, such as residual waste, waste paper and
organic waste
- Always up-to-date and street-accurate
- The smart garbage collection calendar helps you plan weeks in advance
- **Find events / activities:🎭**:
Always stay in the loop about interesting events in your city!
- Find festivals, events and cultural activities in your area
- Use built-in filters for your interests
- Citykey shows you an overview of upcoming events
- Share exciting events with your friends over Citykey
- Add activities and events to your calendar
- **News:🛰**:
- Keep track of the latest city-related news
- Get daily updates about important topics, such as culture, community, citizens, nature and
helpful news
- **Book appointments with offices:👨💼**:
- Book appointments with your local office and minimize waiting times when dealing with
authorities
- Ensure you have all documents required for your appointment and get the location to easily
find the office
- **Digital administration with your eID:📱**:
- Fill out forms for various administrative purposes
- Citykey supports the Online ID (eID) of the ID card for identification on the Internet, so you
can use even more citizen services digitally and mobile-friendly. The electronic residence
permit is also supported
- Take care of common applications in no time at all, such as applying for a resident parking
permit or changing your residency
- **Citizen participation:📝**:
Shaping the city together is now made even easier.
- Take part in surveys on urban development and all projects that affect you
- View all ongoing surveys in an overview
- **Interesting places:🌃**:
New to your city? Get the best tips and first-hand information.
- Find out what characterizes the city and which places are worth a visit
- The app helps you find your way around and get familiar with the city faster
- **Defect reporter:🤳🚧**:
A deep pothole in the road, a crooked guard rail or a defective street light caught your eye?
- Report damaged or defective infrastructure to the city
- Detail your request, simply by sending a photo with a location marker
## Building From Source
If you want to start working on Citykey and if you haven't done already, you
should [familiarize yourself with Android development](https://developer.android.com/training/basics/firstapp/index.html)
and [set up a development environment](https://developer.android.com/sdk/index.html).
The next step is to clone the source code repository.
git clone https://github.com/telekom/CityKey-Android.git
Then, in the file `secrets.properties` present in the root folder, put your own Google Maps API key.
Use `debug` build variant to run the application for debugging purpose.
If you don't want to use an IDE like Android Studio, you can build Citykey on the command line as
follows.
./gradlew assembleRelease
## Contribute
Code contributions are welcome!
You should fork the repo as described
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
See the issues list for bug
reports: [Citykey-Android issues](https://github.com/telekom/CityKey-Android/issues).
Before adding new features, please create an issue, or [contact
us](https://public.telekom.de/digitalisierungsloesungen/smart-city#Kontaktaufnahme).
See the [CONTRIBUTING](CONTRIBUTING.md) file for more details.
## Documentation
All the relevant documentation for this project is kept under [documentation](./documentation) directory. Here you will find:
1. [Guide to add new Services (APIs)](https://github.com/telekom/CityKey-Android/blob/main/documentation/API_INTEGRATION.md).
## Code of Conduct
This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.1 as our code of conduct.
By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
## Licensing
Copyright (c) 2025 Deutsche Telekom AG
Licensed under the **Apache-2.0 (SPDX short identifier: Apache-2.0)** (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License by reviewing the file [LICENSE](./LICENSES/Apache-2.0.txt) in the repository.
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](./LICENSES/Apache-2.0.txt) for the specific language governing permissions and limitations under the License.
In accordance with Sections 4 and 6 of the License, the following exclusions apply:
1. **Trademarks & Logos** – The names, logos, and trademarks of the Licensor are not covered by this License and may not be used without separate permission.
2. **Design Rights** – Visual identities, UI/UX designs, and other graphical elements remain the property of their respective owners and are not licensed under the Apache License 2.0.
3. **Non-Coded Copyrights** – Documentation, images, videos, and other non-software materials require separate authorization for use, modification, or distribution.
These elements are not considered part of the licensed Work or Derivative Works unless explicitly agreed otherwise. All elements must be altered, removed, or replaced before use or distribution. All rights to these materials are reserved, and Contributor accepts no liability for any infringing use. By using this repository, you agree to indemnify and hold harmless Contributor against any claims, costs, or damages arising from your use of the excluded elements.
### Source Code
This project follows the [REUSE standard for software licensing](https://reuse.software). Each file contains copyright and license information, and license texts can be found in the [LICENSES](./LICENSES) folder. For more information visit https://reuse.software.
### Deutsche Telekom Brand
Although the code for the app is free and available under the Apache 2.0 license, Deutsche Telekom fully reserves all rights to the Telekom brand. To prevent users from getting confused about the source of a digital product or experience, there are strict restrictions on using the Telekom brand and design, even when built into code that we provide. For any customization other than explicitly for the Telekom, you must replace the Deutsche Telekom default theme.