SlimeKT

KO | EN

gitlite — search

#ai #python #cli #javascript #typescript #llm #gemini #api #css #nodejs #proxy #golang

★ 607 Open GitHub ↗

An article sharing platform where you can personalize, subscribe to your favorite topics, get daily-read reminders, etc. App built using Kotlin, Dagger Hilt, Room Database, Coroutines, Flow, AndroidX Glance, WorkManager, Coil etc.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Header Image](https://raw.githubusercontent.com/kasem-sm/SlimeKT/dev/docs/assets/header.png)

[![Slime Build (Android)](https://github.com/kasem-sm/SlimeKT/actions/workflows/android_action.yml/badge.svg)](https://github.com/kasem-sm/SlimeKT/actions/workflows/android_action.yml)
[![Slime Build (API)](https://github.com/kasem-sm/SlimeKT/actions/workflows/api_action.yml/badge.svg)](https://github.com/kasem-sm/SlimeKT/actions/workflows/api_action.yml)

[![GitHub stars](https://img.shields.io/github/stars/kasem-sm/SlimeKT?style=social)](https://github.com/kasem-sm/SlimeKT/stargazers)
[![GitHub watchers](https://img.shields.io/github/watchers/kasem-sm/SlimeKT?style=social)](https://github.com/kasem-sm/SlimeKT/watchers)

[![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23515-blue)](https://androidweekly.net/issues/issue-515)
[![Google Dev Library](https://img.shields.io/badge/Google%20Dev%20Library-Android-blue)](https://devlibrary.withgoogle.com/products/android/repos/kasem-sm-SlimeKT)

# Disclaimer
This is an over-engineered project.

## Introduction 🙋‍♂️

An article sharing platform where you can _**personalize, subscribe to your favorite topics, get
daily-read reminders, explore new authors, and share your articles**_. App built using Kotlin, Dagger Hilt, Room Database, Coroutines, Flow, AndroidX Glance, WorkManager, Coil etc.</b>

## Documentation 📚

[![Documentation](https://img.shields.io/badge/Visit-blue?style=for-the-badge)](https://kasem-sm.github.io/SlimeKT)

We have prepared a detailed guide on every feature, API route, and project structure. Please
visit [here](https://kasem-sm.github.io/SlimeKT) to know more about the same. Additionally, every
major folder, such as [`/api`](/api) and [`/features`](/features), contains short documentation in
the Github repository itself.

## Repository overview 📂

SlimeKT has its backend built with Ktor. The folder [`/api`](/api) consists of our backend deployed at [Railway](https://railway.app). SlimeKT Android application resides inside of the [`/app`](/app) folder.

## App Architecture Diagram

It follows the recommended app architecture as stated in
official [Android documentation](https://developer.android.com/jetpack/guide)

![App Architecture](https://raw.githubusercontent.com/kasem-sm/SlimeKT/dev/docs/assets/app_architecture.svg)

## Sample, Screenshots and Demo 📱

[![Slime APK](https://img.shields.io/github/v/release/kasem-sm/slimekt?color=8D0AF2&label=Download&logo=android&style=for-the-badge)](https://github.com/kasem-sm/SlimeKT/releases)

![Screenshot Board 1](https://raw.githubusercontent.com/kasem-sm/SlimeKT/dev/docs/screenshots/board_1.png)

![Screenshot Board 2](https://raw.githubusercontent.com/kasem-sm/SlimeKT/dev/docs/screenshots/board_2.png)

For more screenshots and screen-recording
demo, [please visit our documentation](https://kasem-sm.github.io/SlimeKT).

## What's next ✨

SlimeKT is a _Work In Progress_ project and there are several features/ideas which are yet to be
implemented. You can help us on our journey by contributing your skills. Please checkout
our [Contribution Guide](https://github.com/kasem-sm/SlimeKT#contribution-guide-and-contributors-%EF%B8%8F)
for more.

## Tech stack / Miscellaneous Features 🚀

- <b>Kotlin, Jetpack Compose, Work Manager, Glance API, Material You, Coroutines, Flow, Accompanist, Ktor, Room Database, Coil, Dagger Hilt, Mockk etc.</b>
- **[Compose Destinations:](https://github.com/raamcosta/compose-destinations)** Annotation processing library for type-safe Jetpack Compose navigation with no boilerplate.
- **Observer Pattern:** Data from the cache would be shown while new data is fetched from the
  server. Newly retrieved data gets updated immediately on the screen.
- **WorkManager:** App uses WorkManager API to update user's subscriptions and to fetch Daily Read
  articles.
- **AndroidX Glance:** Daily Read Widget with the power of Jetpack Compose.
- **Material You:** On Android 12 and above, you can have custom theme based on your device
  wallpaper.

Please visit [the documentation of this project](https://kasem-sm.github.io/SlimeKT) for detailed
information.

## Project Setup Guide ⚒

#### Android App

You need to have [Android Studio](https://developer.android.com/studio) Bumblebee or Dolphin to set
up this project locally. After downloading all the requirements, please import the project into
Android Studio, build the project, and click Run.

#### Backend (API)

You need to have [IntelliJ IDEA](https://www.jetbrains.com/idea/download/#section=windows)
and [MongoDB Compass](https://www.mongodb.com/products/compass) installed. After downloading all the
requirements, please import the [`/api`](/api) module into IntelliJ IDEA, build the project and
click the Run icon beside `main` function in `Application.kt` file.

## Test Cases (Android app)

Current Testing status - https://kasem-sm.github.io/SlimeKT/tests/status/

## Contribution Guide and Contributors 👷‍♂️

There are no special rules for contributing your expertise and making the open-source community more
powerful. Just don't forget to file an issue or start a discussion so that I may not be surprised
when you create a pull request. Running `spotlessApply` before creating a pull request would be
_cherry on the cake_.

* Special thanks to our contributors:
    - [List of Contributors](https://github.com/kasem-sm/SlimeKT/graphs/contributors)

## Medium Articles related to this project 🖋

1. [SlimeKT - Kotlin Powered open source project. (Android app with Ktor backend)](https://medium.com/@kasem.sm/slimekt-136a56864e57)
2. Android’s IME Actions: Don’t ignore them. [Read here](https://proandroiddev.com/androids-ime-actions-don-t-ignore-them-36554da892ac)
3. Create Animated PlaceHolder for your Jetpack Compose text fields [Read here](https://medium.com/@kasem.sm/animated-placeholder-with-jetpack-compose-60c85547b47a)
4. When Jetpack's Glance met his fellow worker, WorkManager [Read Here](https://medium.com/@kasem.sm/when-jetpacks-glance-met-his-fellow-worker-work-manager-18cf19eff983)

More articles by [_kasem-sm_](https://medium.com/@kasem.sm) on Medium.

## Find this project useful? 💖

Support it by starring this repository. Join our [Stargazers](https://github.com/kasem-sm/SlimeKT/stargazers) team!

## Contact 🤙

Direct Messages on [My Twitter](https://twitter.com/KasemSM_) are always open. If you have any
questions related to SlimeKT or Android development, ping me anytime!

## Credits 💎

- [**Tivi**](https://github.com/chrisbanes/tivi) by [chrisbanes](https://github.com/chrisbanes) - A
  divine project for me to explore. I refer to this project as Gold 🥇.
- [**Gabor Varadi**](https://twitter.com/Zhuinden) - He is always willing to answer my questions. A
  great man and a blessing to the Android community (AKA, the `SavedStateHandle` preacher).
- [**Doris Liu**](https://twitter.com/doris4lt) and [**Manuel
  Vivo**](https://twitter.com/manuelvicnt) - They always help review my code snippets and add their
  value to them.
- [**Hadi**](https://twitter.com/hadilq) - Assisted me in improving the modularized structure of this project.
- [**Marcel**](https://twitter.com/marxallski) - His [suggestions](https://github.com/kasem-sm/SlimeKT/pull/148) helped me to improve the Glance widget.

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

SlimeKT

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README