Skip to content

Latest commit

 

History

History
76 lines (66 loc) · 4.84 KB

README.md

File metadata and controls

76 lines (66 loc) · 4.84 KB

Example Kotlin Android App

Get started using Kotlin with Android

Features

  • KFormMaster to build the forms
  • Drawer to open different activities
  • Settings with a font size and dark theme
  • Login page
  • Retrofit to make API calls to the Example API
  • GSON for handling JSON data
  • Splash screen
  • RxJava and RxAndroid to get the result or error from Retrofit calls
  • Firebase integration for Notification and Crashlytics support
  • secure-preferences for secure user preferences
  • MPAndroidChart for displaying pie charts
  • richeditor-android for displaying a HTML editor
  • barcodescanner:zxing for displaying a QR code scanner
  • PermissionsDispatcher for asking for the QR camera permission
  • LolliPin for securing the app with a passcode
  • dokka for documentation

Screenshots

Login Drawer Search Contacts
Login Drawer Search Contacts
Contact Details Contact Form Dark Theme
Contact Details Contact Form Dark Theme

Get Started

  • Clone this repository and open it in Android Studio
  • Integrate with Firebase to get a google-services.json file
    • In Android Studio, open the Tools menu and then Firebase
    • Click "Cloud Messaging" and then "Set up Cloud Messaging"
    • Click "Connect to Firebase" and then Create a new Firebase Project
    • Don't click "Add FCM to your app" as that is already setup
  • After starting the app, login using the Example API below
  • Start by searching for Contacts with the name "User"
  • Add a Contact, edit an existing one, or add a HTML Note to a Contact
  • Open the Queue to view a refreshable, API-driven Chart fragment within a programmatically added tab
  • Open Settings to change the font size or theme. Enable the Passcode to setup a passcode required when opening the app from the background.
  • NOTE: The server will stop accepting requests after 24 hours of being logged in. Re-login to get a new session.

Example API

Contributing

You can submit pull requests or issues to this project to make this example Android app even better!

Libraries

References

License

This Android app is available as open source under the terms of the Apache License, Version 2.0.