/city-api-client

Jetpack Compose App for Ktor City API

Primary LanguageKotlinMIT LicenseMIT

Jetpack Compose City API App

This app is a Jetpack Compose front-end for my Ktor City API. Once developers sign up, they can use the app to get API keys for their development and production projects. Features include:

  • Adaptive Layouts for phones, tablets, foldables, and desktops
  • Material 3
  • Google One Tap
  • Hilt
  • Ktor Client
  • English/Spanish/German Onboarding screens
  • Datastore Preferences
  • Search as you type
  • and more

Demo: https://youtu.be/vT5q6dQ-em4?t=43

Project Setup

To run this app, complete the following steps:

  1. Set up the Ktor API

  2. Switch to Project view in Android Studio

  3. Add a new file called app.properties in your project root

  4. Add the following properties, along with your info. The WEB_CLIENT_ID is used for Google One Tap:

    WEB_CLIENT_ID="990009999900-a1bc2defg5hijklmn8.apps.googleusercontent.com"
KTOR_IP_ADDR="127.0.0.1"

For more information, refer to: https://youtu.be/O_SBoS8aH7w?t=170

Branches and Features

I've developed key features in separate branches, and each branch has a corresponding YouTube video. Here's a link to each, in order.

Note: The Ktor API also uses corresponding branches. You can find the correct branch in the GitHub README of each branch.

1. Jetpack Compose: Adaptive Layout Templates, Datastore Preferences with Hilt, Dynamic Onboarding Screens

2. Google One Tap with Jetpack Compose, Ktor HttpClient, Hilt

3. Android Adaptive Navigation: Bottom Nav Bars, Nav Drawers, and Nav Rails with Jetpack Compose

4. Set up, Close, and Use Ktor Client in Your Android Apps

5. Search As You Type/Autocomplete with Compose, Kotlin Coroutines and Kotlin Flows

6. Create, Read, and Patch with Ktor Client and Jetpack Compose

7. Use JUnit 5, MockK, Android coverage, and Kover for Ktor Client Unit Tests