Coder Social home page Coder Social logo

android-app-template's Introduction

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Marvelous Android App Template Project

A base Android App template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot

In Android development, writing a good app depends a lot on its infrastructure from the very beginning. In order to leverage DRY principles and assure that each project has a good birth into this world, I decided to make the best template project that would speed up development for both my projects and yours.

Here is what you get right out of the box:

  • Dependency Injection with Dagger Hilt (Every framework should have DI by default.)
  • A splash screen and home screen setup with Jetpack Compose.
  • Jetpack Compose Navigation Component.
  • Google’s recommended package structure.
  • Stubbed classes as a start for good MVVM architecture.

(back to top)

Built With

Android Kotlin Compose Hilt

(back to top)

Getting Started

At its current state, you can use this project to jumpstart your own by simply cloning it and overwriting the commit history.

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/kevinjoramos/Android-App-Template.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add dependency injection with Hilt.
  • Add splash screen.
  • Add basic screen, viewmodel class, and repository class.
  • Add navigation.
  • Add usage section to README.
  • Build project initializer web app.
    • Android version selector.
    • XML vs Compose option.
    • Build tool selector.
    • Retrofit Add-on.
    • Room Database Add-on.
    • Image Library Add-on.

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Kevin Ramos - @KevinJoRamos - [email protected]

Project Link: https://github.com/kevinjoramos/Android-App-Template

(back to top)

Acknowledgments

(back to top)

android-app-template's People

Contributors

kevinjoramos 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.