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.
This is an over-engineered project.
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.
We have prepared a detailed guide on every feature, API route, and project structure. Please
visit here to know more about the same. Additionally, every
major folder, such as /api
and /features
, contains short documentation in
the Github repository itself.
SlimeKT has its backend built with Ktor. The folder /api
consists of our backend deployed at Railway. SlimeKT Android application resides inside of the /app
folder.
It follows the recommended app architecture as stated in official Android documentation
For more screenshots and screen-recording demo, please visit our documentation.
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 for more.
Please visit the documentation of this project for detailed information.
You need to have Android 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.
You need to have IntelliJ IDEA
and MongoDB Compass installed. After downloading all the
requirements, please import the /api
module into IntelliJ IDEA, build the project and
click the Run icon beside main
function in Application.kt
file.
Current Testing status - https://kasem-sm.github.io/SlimeKT/tests/status/
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.
More articles by kasem-sm on Medium.
Support it by starring this repository. Join our Stargazers team!
Direct Messages on My Twitter are always open. If you have any questions related to SlimeKT or Android development, ping me anytime!
SavedStateHandle
preacher).Copyright 2022 Kasem S.M
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.