Giter Club home page Giter Club logo

android-simple-boilerplate's Introduction

Android Simple Boilerplate

FOSSA Status

Provides a convenient basic start-off point for all your new Android projects.

Tries to employ the best tools and practices.
Does not contain any architectural patterns or solutions.

It draws inspiration from Chris Banes's Tivi but adds many customizations and optimizations.

Note: this project is Kotlin-based and is not designed to be Java-friendly.

Things included

  • Gradle setup with all its little quirks
  • buildSrc module with Gradle Kotlin DSL. It provides autocomplete and other niceties in managing Gradle dependencies
  • CI/CD with automated Unit/Robolectric tests, Firebase Test Lab integration, and Play Store publishing
  • Static code analysis
  • Crash reporting via Crashlytics
  • Firebase Performance Monitoring
  • Simple Dagger2 setup

Usage

For detailed instructions on how to configure this template project for you, see Wiki.

Tools that are used

Build process

Integrations

Testing

Libraries

Included but not used

  • Android KTX for more pleasant usage of Android APIs with Kotlin extension functions
  • Material Design to use components from Material Design guidance
  • Mockito to mock dependencies
  • Mockito-Kotlin to provide more idiomatic usage of Mockito in Kotlin
  • Lifecycles from Android Jetpack to manage Activity and Fragment lifecycles

Contributing

All contributions in form of issues or pull requests are welcome.
You should create an issue first if you want to introduce a significant change.

License

Project License

MIT License

Copyright (c) 2018 Andrii Chubko

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, 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 THE
SOFTWARE.

FOSSA Status

Third-party Licenses

Third-party licenses are included in LICENSE-3RD-PARTY.

android-simple-boilerplate's People

Contributors

fossabot avatar

Watchers

 avatar

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.