diff --git a/README.md b/README.md new file mode 100644 index 0000000..077713d --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Firebase Mobile Signup + +Login to an app by authenicating with a mobile number then update your details + +## Requirements + + - Minimum android SDK version 19 + - Permissions : Internet, Storage + +## Features + + - Login Screen + - Sign up with mobile phone + - select image from gallery + - Update your profile once signed in + +## Architectural Pattern + +MVVM - Model View Viewmodel + +## Jetpack + +* [AndroidX](https://developer.android.com/jetpack) + +## Unit tests + +### Test case one + - UI test for authentification testing during login procedure + +## Built With + +* [Kodein](https://github.com/Kodein-Framework/Kodein-DI) - Painless Kotlin Dependency Injection +* [Retrofit](https://github.com/square/retrofit) - Type-safe HTTP client for Android and Java by Square, Inc +* [Firebase](https://firebase.google.com/) - Firebase is a mobile and web application development platform developed by Firebase + + +## Authors + +* **Haider Malik** - *Android Developer*