Code Monkey home page Code Monkey logo

irish_rail's Introduction

Irish Rail App

Features

The app displays lists of rail data - trains and stations. It allows the user to filter this data by various properties (train code, station code, status, etc.). Users can also see details about trains and stations and can cross navigate between the them.

Train Positions Train Movements
Stations Station Details

Development Environment

The app is written entirely in Kotlin and uses the Gradle build system.

To build the app, use the gradlew build command or use "Import Project" in Android Studio. MinSdkVersion is 28.

Architecture

The architecture is built around Android Architecture Components.

Followed the recommendations laid out in the Guide to App Architecture when deciding on the architecture for the app. Logic is kept away from Activities and Fragments and moved to ViewModels. Observed data using LiveData and Data Binding Library to bind UI components in layouts to the app's data sources.

Repository layer is used for handling data operations. Data comes from a Irish Rail Realtime API and is fetched on the go. The repository modules are responsible for handling all data operations and abstracting the data sources from the rest of the app. (if we wanted to swap the API for a different data source in the future,
the architecture allows to do so in a clean way).

Implemented a lightweight domain layer, which sits between the data layer and the presentation layer, and handles discrete pieces of business logic off the UI thread. See the UseCase.kt files under /domain for examples.

Used Navigation component to simplify into a single Activity app.

Used Dagger2 for dependency injection and heavily relied on dagger-android to abstract away boiler-plate code.

irish_rail's People

Contributors

ivzb avatar

Stargazers

Teodora Nakova avatar

Watchers

James Cloos avatar  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.