Franko

Note

Application made for educational purposes only.

Franko is a fitness and social platform for Android that allows users to seamlessly log their physical activities, such as cycling, walking, and running.

Screenshots

Features

• Login via Google account
• Record three different activity types: cycling, walking, and running
• Filter recorded activities by type
• Set activity name, type, and visibility (public or private)
• Set profile visibility (public or private)
• Search for people using the app
• Follow people
• See who is following your profile
• Edit profile: first and last name, profile picture, bio, and city
• Set profile picture directly from camera or gallery
• English and Polish language

Technology Stack

• Kotlin
  • Coroutines
• Firebase
  • Authentication
  • Cloud Firestore
  • Cloud Storage
• Google Maps API
• Android Views
• Android Jetpack
  • Navigation - navigation in application
  • ViewModel - state holder
  • LiveData - lifecycle-aware observable data holder
  • Lifecycle - performing actions in response to a change in the lifecycle status of another component
  • Preferences DataStore - data storage for user preferences
  • View Binding - interacting with views from code
• Gradle
  • Kotlin DSL
  • Version Catalog

Architecture

• Single activity
• MVVM

Libraries

• Coil - image loading library
• Compressor - image compression library
• Hilt - dependency injection

Testing

• JUnit 5 - unit tests

Static Analysis Tools

• Android Linter
• ktfmt - formatting Kotlin code

Building

1. Google Maps API Key

Create file secrets.properties in root project directory with the following contents. Replace YOUR_API_KEY with your Google Maps API key.

MAPS_API_KEY=YOUR_API_KEY

2. Firebase

Download google-services.json from Firebase Console and put it in the app/ directory.

3. (Optional) Signing

For signing the release build create keystore.properties in root project directory with the following contents and your signing information.

storePassword=myStorePassword
keyPassword=mykeyPassword
keyAlias=myKeyAlias
storeFile=myStoreFileLocation