Skip to content

Commit c61fb43

Browse files
Updated README.md
1 parent aa5cc45 commit c61fb43

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1-
# Gradle Kotlin DSL, ktLint, detekt, Git Hooks Sample
1+
# Boilerplate for creating project with MVVM, Dagger Hilt, Dynamic Feture Modules
22

33
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
44
[![Kotlin Version](https://img.shields.io/badge/kotlin-1.3.72-blue.svg)](https://kotlinlang.org)
55
[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21)
66

7-
Sample boiler plate code to implement Kotlin DSL, ktlint, detekt and Git Hooks to app on app, library and dynamic feature module step by step with each commit. Also added git hooks using script below in ```.git\hooks``` folder with a excutable **pre-commit.sh** to turn simple text to excutable call ```chmod a+x pre-commit```
7+
8+
This is a boilerplate code to use when ceating a project since not to repeat same process over again. Folders are created, dependies and libraries are set up
9+
to create a requirements when starting a new project.
10+
11+
* Gradle Kotlin DSL is used for setting up gradle files
12+
* KtLint, Detekt, and Git Hooks is used for checking, and formatting code and validating code before commits.
13+
* Dagger Hilt, Dynamic Fetaure Modules with Navigation Components, ViewModel, Retrofit, Room, RxJava, Coroutines libraries are set up.
14+
* ```features``` and ```libraries``` folders are used to include android libraries and dynamic feature modules
15+
* In core module dagger hilt dependencies and ```@EntryPoint``` is created
16+
17+
## Gradle Kotlin DSL, ktLint, detekt And Git Hooks Integration
18+
Kotlin DSL, ktlint, detekt and Git Hooks to app on app, library and dynamic feature module step by step with each commit.
19+
Also added git hooks using script below in ```.git\hooks``` folder with a excutable **pre-commit.sh** to turn simple text to excutable call ```chmod a+x pre-commit```
820

921
```
1022
#!/bin/sh

0 commit comments

Comments
 (0)