https://github.com/moallemi/newscards

A news app illustrating Android development best practices with Android Jetpack
https://github.com/moallemi/newscards

android hacktoberfest kotlin

Last synced: 6 days ago
JSON representation

A news app illustrating Android development best practices with Android Jetpack

• Host: GitHub
• URL: https://github.com/moallemi/newscards
• Owner: moallemi
• Created: 2018-10-27T14:02:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-12-09T11:55:56.000Z (almost 4 years ago)
• Last Synced: 2024-05-02T01:43:14.564Z (7 months ago)
• Topics: android, hacktoberfest, kotlin
• Language: Kotlin
• Homepage:
• Size: 235 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
News Cards (alpha)

=========================

A news app illustrating Android development best practices with Android Jetpack.

News Cards is currently released as an alpha and is under heavy development. To view the

latest changes, please visit the

[Releases page](https://github.com/moallemi/NewsCards/releases).

Note that some changes (such as database schema modifications) are not backwards

compatible during this alpha period and may cause the app to crash. In this

case, please uninstall and re-install the app.

Getting Started

---------------

This project uses the Gradle build system. To build this project, use the

`gradlew build` command or use "Import Project" in Android Studio.

There are two Gradle tasks for testing the project:

* `connectedAndroidTest` - for running Espresso on a connected device

* `test` - for running unit tests

Screenshots

-----------

![screenshot](https://github.com/moeindev/NewsCards/blob/update-project/screens/sc.jpg)

Android development

--------------

* [Foundation][0] - Components for core system capabilities, Kotlin extensions and support for

  multidex and automated testing.

  * [AppCompat][1] - Degrade gracefully on older versions of Android.

  * [Android KTX][2] - Write more concise, idiomatic Kotlin code.

  * [Test][4] - An Android testing framework for unit and runtime UI tests.

* [Architecture][10] - A collection of libraries that help you design robust, testable, and

  maintainable apps. Start with classes for managing your UI component lifecycle and handling data

  persistence.

  * [Data Binding][11] - Declaratively bind observable data to UI elements.

  * [Lifecycles][12] - Create a UI that automatically responds to lifecycle events.

  * [LiveData][13] - Build data objects that notify views when the underlying database changes.

  * [Navigation][14] - Handle everything needed for in-app navigation.

  * [Room][16] - Access your app's SQLite database with in-app objects and compile-time checks.

  * [ViewModel][17] - Store UI-related data that isn't destroyed on app rotations. Easily schedule

     asynchronous tasks for optimal execution.

  * [WorkManager][18] - Manage your Android background jobs.

* [UI][30] - Details on why and how to use UI Components in your apps - together or separate

  * [Animations & Transitions][31] - Move widgets and transition between screens.

  * [Fragment][34] - A basic unit of composable UI.

  * [Layout][35] - Lay out widgets using different algorithms.

* Third party

  * [Glide][90] for image loading

[0]: https://developer.android.com/jetpack/foundation/

[1]: https://developer.android.com/topic/libraries/support-library/packages#v7-appcompat

[2]: https://developer.android.com/kotlin/ktx

[4]: https://developer.android.com/training/testing/

[10]: https://developer.android.com/jetpack/arch/

[11]: https://developer.android.com/topic/libraries/data-binding/

[12]: https://developer.android.com/topic/libraries/architecture/lifecycle

[13]: https://developer.android.com/topic/libraries/architecture/livedata

[14]: https://developer.android.com/topic/libraries/architecture/navigation/

[16]: https://developer.android.com/topic/libraries/architecture/room

[17]: https://developer.android.com/topic/libraries/architecture/viewmodel

[18]: https://developer.android.com/topic/libraries/architecture/workmanager

[30]: https://developer.android.com/jetpack/ui/

[31]: https://developer.android.com/training/animation/

[34]: https://developer.android.com/guide/components/fragments

[35]: https://developer.android.com/guide/topics/ui/declaring-layout

[90]: https://bumptech.github.io/glide/

Development setup

------------------------

For development, the latest version of Android Studio 3.4 is required. The latest version can be

downloaded from [here](https://developer.android.com/studio/).

### API keys

You need to supply API / client keys for the various services the

app uses. That is currently [News Api](https://newsapi.org/) and [Fabric](https://fabric.io) (for Crashlytics). You can find information about

how to gain access via the relevant links.

When you obtain the keys, you can provide them to the app by putting the following in the

`gradle.properties` file in your user home:

```

# Get this from News Api

news_cards_news_api_key=

```

On Linux/Mac that file is typically found at `~/.gradle/gradle.properties` or in the project directory `NewsCards/gradle.properties`

## Contributions

If you've found an error in this sample, please file an issue.

Patches are encouraged, and may be submitted by forking this project and

submitting a pull request. Since this project is still in its very early stages,

if your change is substantial, please raise an issue first to discuss it.