Code Monkey home page Code Monkey logo

perfect-android-library-template's Introduction

Perfect-android-library-template

This is how I prefer my android setup. This setup has a sample app and a deployable library that deploys to maven central once released. It uses detekt and lint and uses github actions to verify code in pull requests

Features:

  • Detekt
  • Lint
  • Deploy to maven central
  • Verify PR (github actions)
  • Deployment using github releases
  • Auto versioning based on GIT tags
  • Issue templates
  • Funding
  • CI configurations (ci-gradle.properties)
  • Dependabot
  • PR templates
  • Release management
  • KTS gradle files

How to use this repo as a template

  1. Press "use this template" above or go to https://github.com/warting/Perfect-android-library-template/generate
  2. Make an awesome library
  3. Feel free to change from MIT License to whatever you want!
  4. Create a sonatype account (https://getstream.io/blog/publishing-libraries-to-mavencentral-2021/)
  5. Setup github secrets.
    1. OSSRH_USERNAME
    2. OSSRH_PASSWORD
    3. SONATYPE_STAGING_PROFILE_ID
    4. SIGNING_KEY_ID
    5. SIGNING_PASSWORD
    6. SIGNING_KEY
  6. Deploy your lib using github release functionality

Delete everything above this and change everything below

Maven Central

Title of library

Describe your project here

How to include in your project

The library is available via MavenCentral:

allprojects {
    repositories {
        // ...
        mavenCentral()
    }
}

Add it to your module dependencies:

dependencies {
    implementation("se.warting.perfect-android-library:template:<latest_version>")
}

How to use

All you need to do is to call SampleThingie:

    SampleThingie()

For a full implementation see: Full sample

Notes

Some notes

perfect-android-library-template's People

Contributors

dependabot[bot] avatar warting avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

jalalkun

perfect-android-library-template's Issues

how to set SIGNING_KEY in local.properties

hello, thanks for the template for the library publishing.

but I have one question, how to set SIGNING_KEY at local.properties. export key base64 is had a lot of line keys and how to set it to local.properties.
thanks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.