Skip to content

Template for creating new android projects made with code quality, documentation and ease of setup in mind.

Notifications You must be signed in to change notification settings

mijiga/Android-Project-Template

Repository files navigation

Android-Project-Template

An Android Project Template for creating new Android Projects with out of the box setup for standard libraries and tooling(e.g code formatting, static code analysis, etc) built with Kotlin.

Default Workflow

Tech Stack

Libraries

  • Retrofit
  • Coroutines
  • Jetpack
    • LiveData
    • LifeCycle
    • ViewModel
  • Dagger-Hilt for dependency injection

Plugins

  • Lint/Ktlint
  • Detekt for static code analysis

Documentation

  • Pull request template: Defines a basic structure for you Pull Requests to get the most information from your Pull Requests. See here
  • Issue report template: Defines a basic structure for your Issue reports so as to get comprehensive Issue Reports.

File Structure

CI Workflow

The Github Actions Continuous Integration workflow is exectuted on every Pull Request or Push to the Main branch. The workflow has the following jobs:

  • Ktlint and Lint check job
  • Test job: runs the project's tests
  • Assemble job: builds the project

Author

Steve Chikwiri

License

About

Template for creating new android projects made with code quality, documentation and ease of setup in mind.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages