This app provides an easy and convenient way for clients of ReturnPal to schedule and track their returns from their Android device.
- Intuitive, user-friendly graphical interface.
- Secure Connection to ReturnPal's server.
- Ability to manage a ReturnPal user account.
- Ability to manage pricing plan with ReturnPal.
- Ability to schedule returns with ReturnPal.
- Ability to contact ReturnPal directly via help chat.
We use a layered architecture, keeping the implementation of all data-related operations strictly within a data layer and all UI-related operations within the UI layer. This enforces a separation of concerns within the application. Layers are decoupled and significant changes can be made to one layer without affecting the other layer, allowing simultaneous development of both the UI and Data layer. In addition this isolates bugged code and makes long-term maintenance easier.
TODO combine the two images above into one image without the domain layer
We use the repository design pattern to represent the server within the mobile app. A repository is a class that wraps around one (and only one) data source and mediates reading and writing to that data source. In this case, the data source is a connection to the ReturnPal server. Data exposed by this repository should be immutable so that it cannot be tampered with outside the repository. Repositories allow us to abstract the data-related operations away from the rest of the application.
We use ViewModel objects to format data from the repository in such a manner that it can be processed by the UI layer. This way UI elements are not coupled to any specific repository implementation.
We are using AWS Amplify to host our user pools and data tables. AWS provides users a single entry point to access multiple AWS micro services.
We are using DynamoDB, Cognito, and S3 buckets behind the Amplify API.
Download App from relevant hosting platform upon release
TODO Show how someone would use the app.
Installation Provide instructions on how to install your project. Include any dependencies or prerequisites.
Download the latest version of Android Studio. Start a new project from Version Control. Select Version Control Git. Use the URL: https://github.com/BC-CS481-Capstone/ReturnPalsApp Clone the remote repository to your local device.
Configuration Configure an emulator in Android Studio to test the app.
Example Configuration: Pixel 7 Pro API 30 Pixel 4 API 30
build.gradle.kts
Sample android { namespace = "com.example.returnpals" compileSdk = 34 defaultConfig { applicationId = "com.example.returnpals" minSdk = 30 targetSdk = 34 versionCode = 1 versionName = "1.0" testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" vectorDrawables { useSupportLibrary = true } } buildTypes { release { isMinifyEnabled = false proguardFiles( getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro" ) } } compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 } kotlinOptions { jvmTarget = "1.8" } buildFeatures { compose = true viewBinding = true } composeOptions { kotlinCompilerExtensionVersion = "1.4.3" } packaging { resources { excludes += "/META-INF/{AL2.0,LGPL2.1}" } } buildFeatures { viewBinding = true } }
Usage Run unit test with emulator. Build with gradlew
Example Usage:
$ gradlew build
Contributing We are always looking for improvements to our UI.
- Create issues for missing information or incorrect scaling.
- Solve issues of incorrect scaling or missing content.
- Create issues for request to change on backend.
- Add new features:
- Add live chat for chatting with drivers.
- Add live tracking of pickup.
License TODO Specify the license under which your project is distributed. For example, MIT License, Apache License, etc.