Share files seamlessly with file.io-Android-Client!
Developed with the software and tools below.
Table of Contents
file.io-Android-Client is an Android application for secure and convenient file uploads. It includes features such as file upload history management, notification alerts for successful uploads, and obfuscation for enhanced security. The project utilizes Android architecture components like Room database, WorkManager for background tasks, and Fuel for HTTP requests. With a user-friendly interface, swiping to delete items, and interactive fragments, file.io-Android-Client offers a seamless experience for users to upload files with ease and track their upload history efficiently.
| Feature | Description | |
|---|---|---|
| ⚙️ | Architecture | The project follows a clean MVVM architecture with ViewModel, Repository, and UI components separated. It leverages Android Jetpack components like Room for database operations and WorkManager for background processing. |
| 🔩 | Code Quality | The codebase adheres to Kotlin coding standards and best practices. It uses consistent naming conventions, follows SOLID principles, and includes unit tests for critical components. |
| 📄 | Documentation | The project has detailed inline comments, README files, and descriptive commit messages. Additionally, it includes documentation for classes and methods to aid in understanding the codebase. |
| 🔌 | Integrations | Key integrations include Firebase for analytics, Katana for dependency injection, and Fuel for making HTTP requests. Google services are integrated for notifications and WorkManager for managing background tasks. |
| 🧩 | Modularity | The codebase is modular, with separate packages for UI, ViewModel, Repository, and utils. This structure allows for easy maintenance, testing, and reusability of components across the project. |
| 🧪 | Testing | Testing is done using JUnit for unit tests and Espresso for UI tests. Mocking frameworks like Mockito are utilized for simulating dependencies. Tests cover ViewModel logic, database operations, and UI interactions. |
| ⚡️ | Performance | The app is designed for efficiency with optimized network requests using Fuel, background tasks handled by WorkManager, and local data storage managed by Room database. The architecture aims to provide a smooth user experience. |
| 🛡️ | Security | Data protection measures include ProGuard for code obfuscation, ensuring secure HTTP requests with Fuel, and handling sensitive information securely. Permissions are carefully managed, and network security best practices are followed. |
| 📦 | Dependencies | Key external libraries and dependencies include AndroidX components, Material design support, Kotlin extensions, Timber for logging, and Gson for JSON serialization. These libraries enhance app functionality and development speed. |
└── file.io-Android-Client/
├── LICENSE
├── README.md
├── app
│ ├── .gitignore
│ ├── build
│ ├── build.gradle
│ ├── proguard-rules.pro
│ ├── release
│ └── src
├── build.gradle
├── gradle
│ ├── .DS_Store
│ └── wrapper
├── gradle.properties
├── gradlew
├── screenshots
│ ├── readme.txt
│ ├── screen1.png
│ ├── screen2.png
│ ├── screenshot.png
│ └── todo-ui.png
└── settings.gradle.
| File | Summary |
|---|---|
| build.gradle | Configures build dependencies for Android project-includes Google, Fabric.io, and Kotlin Gradle plugins with specific versions. |
| settings.gradle | Manages app module configuration and inclusion within the project's build process. |
screenshots
| File | Summary |
|---|---|
| readme.txt | Generates and organizes project screenshots for documentation purposes. |
app
| File | Summary |
|---|---|
| proguard-rules.pro | Enhances app security via ProGuard rules for obfuscation and optimization. Maintains specific configurations for ProGuard in Android projects, ensuring code protection and efficiency. |
| build.gradle | Configure Android application build settings, dependencies, and plugins for the file path app/build.gradle in the Android client repository. |
app.src.androidTest.java.com.thecoolguy.rumaan.fileio
| File | Summary |
|---|---|
| ExampleInstrumentedTest.kt | Android Instrumented Test ensuring correct package name in the app under test. |
| FileEntityDaoTest.java | Tests database operations on FileEntity using RoomDB in Android app. Performs row count checks, insertion, and retrieval of multiple items. |
| UploadHistoryInstrumentedTest.java | Implements database interactions for UploadHistoryActivity with Room database, inserting test data for upload items. |
app.src.test.java.com.thecoolguy.rumaan.fileio
| File | Summary |
|---|---|
| ExampleUnitTest.java | Unit test ensuring addition correctness in Android app via JUnit assertions, contributing to app reliability. |
| UploadRepositoryTest.java | Test code to validate URL expiration functionality and constants in the upload repository of the Android client app. |
| UrlTest.java | Test URL parsing functionality for the Android Client app. Verifies URL extraction from encrypted link. |
| FileEntityTest.java | Test code for setting and checking properties in FileEntity model. |
app.src.main.java.com.thecoolguy.rumaan.fileio.viewmodel
| File | Summary |
|---|---|
| UploadHistoryViewModel.kt | ViewModel for Upload History in File.io Android Client repository. Manages file upload records using Room database. |
app.src.main.java.com.thecoolguy.rumaan.fileio.ui
| File | Summary |
|---|---|
| FileioApplication.kt | Base Application class for file.io Android client managing logging with Timber and custom error handling using Custom Activity on Crash library. |
| UploadHistoryListAdapter.kt | Custom RecyclerView adapter for displaying upload history with date separators and clickable file entries. |
| SwipeToDeleteCallBack.kt | Enables swipe-to-delete functionality for RecyclerView items, featuring a red background and delete icon. Prevents swipes on specific views. |
| NotificationHelper.kt | Manages notifications upon successful file uploads, including creation, customization, and display with optional channel support. |
app.src.main.java.com.thecoolguy.rumaan.fileio.ui.fragments
| File | Summary |
|---|---|
| NoNetworkDialogFragment.kt | Dialog fragment for handling no network error, providing a customizable dialog with an OK button, facilitating interaction with the user. |
| HomeFragment.kt | Implementing a HomeFragment for user interaction, facilitating file upload callbacks via a chosen file button click. |
| ResultFragment.kt | Fragment for displaying result details and interaction. Implements UI components, clipboard functionality, and fragment lifecycle methods for handling user interactions within the Android app. |
app.src.main.java.com.thecoolguy.rumaan.fileio.ui.activities
| File | Summary |
|---|---|
| MainActivity.kt | Entry point for the Android client UI. Manages file uploads, displays results, and handles permissions. Integrates with WorkManager for upload processing. |
| ErrorActivity.kt | ErrorActivity handles runtime crashes by displaying an error screen and ensuring app stability through an affinity finish. |
| UploadHistoryActivity.kt | Clear/remove items, swipe to delete, group by date, and display in a list with animations. |
| AboutActivity.kt | Manages the About section UI functionality, enabling navigation to the License page and incorporating a transparent navigation style. |
| LicenseActivity.kt | Generates Open Source License details for various components in Android app using MaterialAboutLibrary. |
app.src.main.java.com.thecoolguy.rumaan.fileio.repository
| File | Summary |
|---|---|
| UploadHistoryWorkers.kt | Worker classes for uploading history management in the Android client app. ClearHistoryWorker clears all items, DeleteSingleItemWorker deletes a specified item by ID. |
| UploadWorker.kt | Manages file upload tasks, saving to DB, and sending notifications. Utilizes Fuel for HTTP requests and WorkManager for background processing. |
app.src.main.java.com.thecoolguy.rumaan.fileio.utils
| File | Summary |
|---|---|
| Extensions.kt | Adds toast messages and clickability toggling functionality to Android views. |
| WorkManagerHelper.kt | Creates a one-time upload task with specified constraints using WorkManager for the Android client app in the repository. |
| Utils.kt | Provides a set of utility methods for Android tasks, such as handling file details, file operations, network status check, dialog management, and more. |
| Helpers.kt | Extracts file metadata and composes it into a FileEntity within the Android client. Includes functions to fetch file data and return a File object. |
| FragmentHelperExtensions.kt | Conveniently manage fragment transactions in Android app with support for adding and replacing fragments seamlessly. Enhance user experience during navigation. |
| MaterialIn.kt | Animate views with Material Design-inspired entrance effects based on specified directions like bottom or top, incorporating fading and sliding animations for smooth UI transitions. |
| Constants.kt | Define global constants for API base URL, expiry parameters, default expiration, URLs for Github and Twitter, email address, suffix for download links, and timestamp format. |
app.src.main.java.com.thecoolguy.rumaan.fileio.listeners
| File | Summary |
|---|---|
| DialogClickListener.kt | Interface for handling click events on dialogs in the Android client app. |
| OnFragmentInteractionListener.kt | Defines an interface for fragment interactions, enabling actions like file uploads and completion triggers. |
Requirements
Ensure you have the following dependencies installed on your system:
- Kotlin:
version x.y.z
- Clone the file.io-Android-Client repository:
git clone https://github.com/rumaan/file.io-Android-Client- Change to the project directory:
cd file.io-Android-Client- Install the dependencies:
gradle buildUse the following command to run file.io-Android-Client:
java -jar build/libs/myapp.jarUse the following command to run tests:
gradle test-
► INSERT-TASK-1 -
► INSERT-TASK-2 -
► ...
Contributions are welcome! Here are several ways you can contribute:
- Report Issues: Submit bugs found or log feature requests for the
file.io-Android-Clientproject. - Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone https://github.com/rumaan/file.io-Android-Client
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.
- List any resources, contributors, inspiration, etc. here.