Home

MyCV

Architecture Diagram

Why MVP?

1. Simplicity
2. Testability
3. Extensibility

Why Reactive Extensions (Rx)?

Reactive Extensions makes asynchronous programming easy with observable streams especially event driven programs like Android app.

JSON Resume

• JSON Resume is a community driven open source initiative to create JSON-based standard for resumes.
• It is used as REST API to get CV data from backend.

Testing

Unit Tests

• JUnit tests for testing presenter, repository, data source

Mocking

• Mocking of final classes and methods of Kotlin using mockito extension mock-maker-inline

UI Tests (Espresso + Robot Pattern)

• Espresso tests for testing UI using Robot Pattern and Kotlin DSL

Prerequisites

• It needs keystore.properties file, which is not published on git, to build the project. It contains base URL for the API.

TODO v1.0

• MVP with repository as architectural pattern
• LifecycleObserver from Android Architecture Components for making Presenter lifecycle aware
• Reactive programming using Rx
• User conventional way to inject dependencies into Activity
• Retrofit 2 for networking with OkHttp as client
• UI Tests using Espresso and Robot pattern
• Capture UI Test Screenshots using Android Testing Support Library
• Fake data source for easy UI testing
• Unit test presenters and repositories using AndroidJUnitRunner
• Mocking using Mockito 2
• Use JSON Resume for showing JSON-based resumes
• CI/CD using Travis CI
• Add open source license
• Design architecture diagram for README

TODO v2.0

• MVVM with LiveData, ViewModel and DataBinding
• ORM to support offline using Room
• Stubbed data for UI tests using MockWebServer
• Replace Dagger with Koin as dependency injection framework
• Replace AndroidJUnitRunner with JUnit4 rules with AndroidX Test
• Replace dependency injection framework with Dagger 2
• Replace Rx with Kotlin Coroutines
• Install Git hooks
• Write blog post explaining the architecture and tools used

License

MIT License

Copyright (c) 2018 Bharat Dodeja

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.