Skip to content

DavidMagdyNawar/Communi-Android

 
 

Repository files navigation

Communi 🤖

An Application for the community built by the community

What is inside the project 🎨

  • 100% Kotlin-only.
  • 100% Gradle Kotlin DSL setup.
  • Dependency versions managed via buildSrc.
  • Kotlin Static Analysis via ktlint and detekt.
  • Issues Template (bug report + feature request)
  • Pull Request Template.

Gradle Setup 🐘

This template is using Gradle Kotlin DSL as well as the Plugin DSL to setup the build.

Dependencies are centralized inside the Dependencies.kt file in the buildSrc folder. This provides convenient auto-completion when writing your gradle files.

Naming convensions

Please check and read this guideline

GitFlow

We follow this GitFlow guideline

We Use Git Emojis

To make our git commits more enjoyable and useful we use GitMoji. It a source of Emojis to include in your commit message , Find you suits your commit most and add your commit message + the emoji code name from the website. It's also helpful to indicate commit purpose, and pays off when we want to filter commits that for example related to performance only.

Static Analysis 🔍

This template is using ktlint with the ktlint-gradle plugin to format your code. To reformat all the source code as well as the buildscript you can run the ktlintFormat gradle task.

This template is also using detekt to analyze the source code, with the configuration that is stored in the detekt.yml file (the file has been generated with the detektGenerateConfig task).

About

An open source community application

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 100.0%