Repository files navigation

A template for creating new repositories for the new Android Project.

This repository is meant to serve as a general template for how to set up new repository for Android. In general, setting up a new repository takes 30-60 minutes; use this repository as a way of setting up in 5 minutes, and use the following checklist to ensure that you've set up the repository correctly.It has additional modules and files to save your time.

• BuildSrc module (for handling dependecies at one place).
• Core module (includes Kotlin Extensions, Base classess etc.).
• Static tool analysis with Report generation (Ktlint, KtlintAutoFormat Detekt, Custom Detekt Lint Rules).
• Android CI (using Github's Action workflow)
• .gitignore for Android Studio Projects.
• and many more to come....

These instructions are basic; The important part is making sure that you follow the checklist for error free setup.

• Click onuse this template on this repository.
• Enter your Github repo name.
• Uncheckinclude all branches option.
• Click oncreate repo from template button.now your repo has been created.

• Clone your newly created github repo into Android Studio.
• Go tosettings.gradle and changerootProject.name as per your project name.
• Go to App'sbuild.gradle and changeapplicationId as per your project package.
• Go to App's modulestrings.xml and changeapp_name to your app name.
• Delete Readme.MD file.
• [Optional] Go tothemes.xml and refactor Base Application them's nameTheme.AndroidRepoGithubTemplate as per your requirements.that's it.

• CI is only triggred on pull request. If you need to change action go toandroid-master.yml
• You can edit rules forDetekt in thisdetekt-rule.yml.

This projects uses detekt and ktlint static code analyser in CI/CD pipeline to maintain code quality. they also genrated reports.

Use./gradlew detekt

Reports location for each module-
-/app/build/reports/detekt/report.html
-/core/build/reports/detekt/report.html

Use./gradlew ktlint

Reports location for each module-
-/app/build/reports/ktlint/ktlint-checkstyle-report.xml
-/core/build/reports/ktlint/ktlint-checkstyle-report.xml

Use./gradlew ktlintFormat

Please fork this repository and contribute back usingpull requests.

Any contributions, large or small, major features, bug fixes, are welcomed and appreciatedbut will be thoroughly reviewed .

• Blog
• Youtube Channel
• Github
• Linkedin

MIT LicenseCopyright (c) 2020 Happy SinghPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.```