enes-kayiklik/kou-social

🎓 University social media and event sharing app made with Jetpack Compose

KOU Social 🎓

University social media and event app Demonstrate the Jetpack Compose UI using Firebase as Database. Made with ❤️ by Enes

UI Inspirations 🎨

Polls item by Jonah Grindler

Meal List by simantOo

Create Poll by Damir

Profile by Evgen Kuznetsov

Settings by Den Klenkov

Beautiful icon pack 📦

Pela Icon by PelaTeam

Architecture 🗼

• Single Activity No Fragment
• MVVM Pattern

View: Renders UI and delegates user actions to ViewModel

ViewModel: Can have simple UI logic but most of the time just gets the data from UseCase.

UseCase: Contains all business rules and they written in the manner of single responsibility principle.

Repository: Single source of data. Responsible to get data from one or more data sources.

For more information you can check Guide to app architecture

Screens 🖼

Prerequisites

• Local Properties Setup

  inside local.properties file add this three below line and Rebuild project.

  • apiPath="meallist/meal_list/main/b69b930d.json"

  • baseUrl="https://raw.githubusercontent.com/"

  • clientId="YOUR CLIENT ID HERE"

    • You can get this client id from Google Cloud Console
      1. First create Firebase Application
      2. Open cloud console and select your account where you created the Firebase application
      3. When you select your account your application should automatically show up on top left corner. If it's not then select your applicaiton by clicking Select a project button
      4. Create OAuth 2 Web Credential from Credentials section
      5. Copy Client id and paste it
      6. For more information follow the Guideline

• Firebase Setup

  • Enable Firebase Features
    1. Create applicaiton using Firebase Console
    2. Enable email and Google login from Authenticaiton -> Sign in provider section
    3. Enable Firestore Database
    4. Enable Storage
  • Setup Project
    1. Add your debug and release SHA-1 key from Project Settings section
    2. Download google_services.json and paste to your project directory

• Useful Links

  • How to store API key? - Stackoverflow
  • How to add SHA-1 Key to Firebase - Stackoverflow
  • Firebase Documentaton - Firebase

Libraries 📚

• Kotlin - First class and official programming language for Android development.
• Retrofit - A type-safe HTTP client for Android and Java.
• Jetpack Compose - Jetpack Compose is Android’s modern toolkit for building native UI.
• Accompanist - A collection of extension libraries for Jetpack Compose.
  • Pager - Pager composable for Jetpack Compose.
  • Navigation Animation - Animated Navigation for Jetpack Compose.
  • Swipe to Refresh - Swipe Refresh layout for Jetpack Compose.
• Coroutines - For asynchronous and more..
• Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
  • Flows - Data objects that notify views when the underlying database changes.
  • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
  • Jetpack DataStore - Jetpack DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers.
• Compose Destinations - A KSP library that processes annotations and generates code that uses Official Jetpack Compose Navigation under the hood. It hides from you the non-type-safe and boilerplate code you would otherwise have to write.
• Firebase - Firebase is an app development platform that helps you build and grow apps and games users love. Backed by Google and trusted by millions of businesses around the world.
• Material Components for Android - Modular and customizable Material Design UI components for Android.
• Dagger - Hilt - Dependency Injection Framework.
• Coil - Coroutine image loader library.
• Jsoup - HTML parser library.
• Compressor - An android image compression library.

Package Structure 🗂

.
.
.
├── di                    # Hilt Dependency Injection
├── feature               # Screens, components and view models
|
├── data                  # DTOs and repositories 
|    |
|    ├── event            # Screen Event classes
|    | 
|    ├── model            # models
|    |
|    ├── remote           # Retrofit API interfaces
|    | 
|    ├── repository       # Repository classes
|    |
|    └── state            # Screen States
|
├── core                    
|    ├── ui               # Compose Theme
|    |               
|    └── component        # Main Activity components
|
├── utils                 # Useful classes, extensions and more
|
└── Eventverse.kt         # @HiltAndroidApp

Contribute 🤝

If you want to contribute to this app, you're always welcome!

License 📄

Copyright (c) 2022 Enes Kayıklık

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.