FLICK

Build your own IM application. Fast and simple!

Provide out of the box way to create your own social media applications with different services.

Features

Beta

• [x] Authentication
• [x] Friend list
• [x] Chat
• [x] Search friend
• [x] Friend request
• [x] Notification
• [x] Local database
• [x] Latest message
• [x] Unread message count
• [x] Dark mode

Future features

• [ ] Profile
• [ ] Group chat
• [ ] Feed
• [ ] Preference Settings
• [ ] Light mode
• [ ] Call (Audio/Video)
• [ ] Emotes
• [ ] Message Withdrawal
• [ ] Custom Theme
• [ ] Notification Channel
• [ ] i18n

Services

• Public server - Beta
• Own server using Ktor - Beta
• Google Firebase - Planning
• MongoDB Realm - Planning

Frameworks

Common

• Architecture — MVVM
• Database - Locally stored using Room, Key-value stored using DataStore
• UI/UX - Pure Jetpack compose, designed with Figma
• Dependency injection - Hilt

Public server

• Server - Host on AWS EC2
• Database - Remotely stored using MongoDB
• Network - Ktor
• API - REST API

Building

1. Clone the repository
2. Create a local.properties file in the root of the project
3. Open the project in Android Studio and open the 'local.properties' file you just created
4. Add the following lines to the file:

   sdk.dir=<path to your Android SDK>
   serverIP=<your server IP> # Example: 127.0.0.1:8080 or www.example.com
   

5. Press the run button to build and run the app