https://github.com/alira1122/l2
https://github.com/alira1122/l2
android-app coroutines hilt-dependency-injection junit kotlin-flow mockito mvvm retrofit2 viewmodel
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alira1122/l2
- Owner: AliRa1122
- License: mit
- Created: 2024-09-05T07:59:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T11:33:41.000Z (10 months ago)
- Last Synced: 2024-10-31T08:42:55.670Z (8 months ago)
- Topics: android-app, coroutines, hilt-dependency-injection, junit, kotlin-flow, mockito, mvvm, retrofit2, viewmodel
- Language: Kotlin
- Homepage:
- Size: 149 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Wildlife Explorer App**
Wildlife Explorer is an Android application that allows users to explore and learn about various animal species. This app provides detailed information about different animals, including their habitat, diet, conservation status, and more.
**Features**
- User authentication
- Browse a list of animal species
- View detailed information about each species
- Beautiful and intuitive user interface
**Prerequisites**
Before you begin, ensure you have met the following requirements:
- Android Studio Arctic Fox (2020.3.1) or later
- JDK 11 or later
- Android SDK with API level 33 (Android 13) or later
- Gradle 8.0 or later
**Getting Started**
To get a local copy up and running, follow these simple steps:
1. Clone the repository:
```
git clone https://github.com/yourusername/wildlife-explorer.git
```
2. Open Android Studio and select "Open an Existing Project".
3. Navigate to the cloned repository and select it.
4. Wait for Android Studio to finish syncing and indexing the project.
**Building the App**
To build the app, follow these steps:
1. In Android Studio, select "Build" from the top menu.
2. Click on "Make Project" or use the shortcut Ctrl+F9 (Cmd+F9 on Mac).
3. Wait for the build process to complete.
**Running the App**
To run the app on an emulator or physical device:
1. Create an Android Virtual Device (AVD) in Android Studio or connect a physical Android device to your computer.
2. In Android Studio, select "Run" from the top menu.
3. Click on "Run 'app'" or use the shortcut Shift+F10 (Ctrl+R on Mac).
4. Select the target device (emulator or physical device) and click "OK".
The app should now install and launch on your selected device.
**Dependencies**
The app uses the following main dependencies:
- AndroidX libraries
- Material Design components
- Retrofit for API calls
- Coroutines for asynchronous programming
- ViewModel and LiveData for MVVM architecture
- Hilt for Dependency Injection
For a complete list of dependencies, please refer to the build.gradle files in the project.
**Configuration**
If you need to change the API endpoint or other configuration parameters:
1. Open the app/src/main/java/com/example/app/utils/APIService.kt file.
2. Modify the BASE\_URL constant to point to your desired API endpoint.
**Testing**
The project includes unit tests for the ViewModels and Repositories. To run the tests:
1. In Android Studio, right-click on the app/src/test directory.
2. Select "Run Tests in 'app'" from the context menu.
**Contributing**
Contributions to the Wildlife Explorer app are welcome. Please feel free to submit a Pull Request.
**Contact**
If you have any questions or suggestions, please open an issue on the GitHub repository.
Thank you for using Wildlife Explorer!
**Demo**
