https://github.com/waffiqaziz/hilttestactivity

Simple Android Project with Jetpack Compose, Hilt, and CircleCI Integration
https://github.com/waffiqaziz/hilttestactivity

android circleci hilt instrumented-test jetpack-compose testing ui-testing

Last synced: 14 days ago
JSON representation

Simple Android Project with Jetpack Compose, Hilt, and CircleCI Integration

• Host: GitHub
• URL: https://github.com/waffiqaziz/hilttestactivity
• Owner: waffiqaziz
• License: mit
• Created: 2024-12-09T14:40:38.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2025-01-30T18:14:04.000Z (21 days ago)
• Last Synced: 2025-01-30T19:26:34.273Z (21 days ago)
• Topics: android, circleci, hilt, instrumented-test, jetpack-compose, testing, ui-testing
• Language: Kotlin
• Homepage:
• Size: 158 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# HiltTestActivity

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/waffiqaziz/HiltTestActivity/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/waffiqaziz/HiltTestActivity/tree/main)

![GitHub License](https://img.shields.io/github/license/waffiqaziz/HiltTestActivity)

This repository contains a simple Android project demonstrating the use of **Jetpack Compose** for building UI, **Hilt** for dependency injection, and **CircleCI** for continuous integration and testing. The project focuses on **instrumented testing (UI testing)** using **Jetpack Compose Test APIs**.

## 🛠️ Tech Stack

- **Kotlin**: 100% Kotlin codebase.

- **Jetpack Compose**: For declarative UI development.

- **Hilt**: For managing dependencies.

- **Jetpack Compose Test APIs**: For UI and instrumented testing.

- **CircleCI**: For CI/CD pipeline.

---

## 📁 Project Structure

``` bash

├── app/                    # Main application module 

│ ├── src/main/             # Source files for the app 

│ ├── src/androidTest/      # Instrumentation (UI) tests 

├── .circleci/              # CircleCI configuration 

│ └── config.yml            # CircleCI pipeline setup 

└── build.gradle            # Project-level Gradle file

```

## 🖥️ Setup Instructions

1. Clone the repository:

   ```bash

   git clone https://github.com/waffiqaziz/HiltTestActivity.git

   ```

2. Open the project in Android Studio.

3. Sync Gradle dependencies:

   Go to File > Sync Project with Gradle Files.

4. Run the application:

   Select a device/emulator and click on Run ▶️.

   Run UI tests:

5. Execute the instrumented tests with:

   ```bash

   ./gradlew connectedAndroidTest

   ```

## 🔗 CI/CD with CircleCI

This project includes a `.circleci/config.yml` file for automating builds and tests. To use CircleCI:

1. Push the repository to GitHub or another supported VCS.

2. Set up the project on [CircleCI](https://circleci.com/).

3. Customize the `config.yml` file if needed.

4. Monitor builds and test results on the CircleCI dashboard.

## 🤝 Contributing

Contributions are welcome! Please read this [page](CONTRIBUTING.md).