Roommates🏠

A small demo application for finding roommates. The backend is written in Kotlin using Ktor.

🛠️ Tech stack & Open-source libraries

• Minimum SDK level 21
• Kotlin, Coroutines and Flow
• Hilt for dependency injection.
• JetPack
  • Compose - A modern toolkit for building native Android UI.
  • ViewModel - UI related data holder, lifecycle aware.
  • Room Persistence - abstraction layer for local SQLite database.
  • DataStore - store user settings asynchronously with Kotlin Coroutines and Flow.
• MVVM (Model - ViewModel - View) Architecture
• Ktor-client - Type-safe HTTP client used to connect to the backend API.
• kotlinx.serialization - JSON parser.
• Coil - loading images from the network.
• Compose Destinations - Annotation processing library for type-safe Jetpack Compose navigation with no boilerplate.
• Ktor-server - server side Ktor
• KMongo - Kotlin toolkit for Mongo
• Koin - dependency injection for Ktor

🎬 Preview

📅 TODO

• Add tests
• Implement Firebase Authentication and FCM for push notifications
• Improve stability, fix any bugs

🌟Huge Thanks

• Philipp Lackner - very clear and straight to the point tutorials.
• Rafael Costa - provided help with Compose Destinations.
• Jaewoong Eum - has a ton of amazing articles on medium and open-source libraries. Also this README format.
• davideC00 - Compose CardStack.

Contents Credits

All copyrights of the contents, concepts, and phrases used for this open-source project belong to The Walt Disney Company.

📝 License

MIT License

Copyright (c) 2022 Kostadin Arabadzhiev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.