Git Product home page Git Product logo

mansourx / political-preparedness-final Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 1.0 456 KB

PolitcalPreparedness is an example application built to demonstrate core Android Development skills as presented in the Udacity Android Developers Kotlin curriculum. This app demonstrates the following views and techniques: - [Retrofit](https://square.github.io/retrofit/) to make api calls to an HTTP web service. - [Moshi](https://github.com/square/moshi) which handles the deserialization of the returned JSON to Kotlin data objects. - [Glide](https://bumptech.github.io/glide/) to load and cache images by URL. - [Room](https://developer.android.com/training/data-storage/room) for local database storage. It leverages the following components from the Jetpack library: - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - [Data Binding](https://developer.android.com/topic/libraries/data-binding/) with binding adapters - [Navigation](https://developer.android.com/topic/libraries/architecture/navigation/) with the SafeArgs plugin for parameter passing between fragments

License: Apache License 2.0

Kotlin 100.00%
android api clean-architecture dependency-injection kotlin-android kotlin-coroutines moshi moshi-converter mvvm-architecture recyclerview

political-preparedness-final's Introduction

Political Preparedness

PolitcalPreparedness is an example application built to demonstrate core Android Development skills as presented in the Udacity Android Developers Kotlin curriculum.

This app demonstrates the following views and techniques:

  • Retrofit to make api calls to an HTTP web service.
  • Moshi which handles the deserialization of the returned JSON to Kotlin data objects.
  • Glide to load and cache images by URL.
  • Room for local database storage.

It leverages the following components from the Jetpack library:

Setting up the Repository

To get started with this project, simply pull the repository and import the project into Android Studio. From there, deploy the project to an emulator or device.

  • NOTE: In order for this project to pull data, you will need to add your API Key to the project as a value in the CivicsHttpClient. You can generate an API Key from the Google Developers Console

Getting Started

  • For the most part, the TODOs in the project will guide you through getting the project completed. There is a general package architecture and most files are present.
  • Hints are provided for tricky parts of the application that may extend beyond basic Android development skills.
  • As databinding is integral to the project architecture, it is important to be familiar with the IDE features such s cleaning and rebuilding the project as well as invalidating caches.

Suggested Workflow

  • It is recommend you save all beautification until the end of the project. Ensure functionality first, then clean up UI. While UI is a component of the application, it is best to deliver a functional product.
  • Start by getting all screens in the application to navigate to each other, even with dummy data. If needed, comment out stub code to get the application to compile. You will need to create actions in nav_graph.xml and UI elements to trigger the navigation.
  • Create an API key and begin work on the Elections Fragment and associated ViewModel.
    • Use the elections endpoint in the Civics API and requires no parameters.
    • You will need to create a file to complete the step.
    • This will require edits to the Manifest.
    • Link the election to the Voter Info Fragment.
  • Begin work on the Voter Info Fragment and associated ViewModel.
  • Begin work on the Representative Fragment and associated ViewModel.
    • This will require edits to Gradle.
    • You will need to create a file to complete the step.

Report Issues

Notice any issues with a repository? Please file a github issue in the repository.

Screenshots

Screenshot1 Screenshot2 Screenshot2 Screenshot2

political-preparedness-final's People

Contributors

mansourx avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

sharanyasakote

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.