Introduction

Introduction

Get started

1. Clone the repository.

   git clone https://github.com/LawnchairLauncher/lawnicons.git

2. Open the project in Android Studio.
3. Run the app configuration.

Development practices

To ensure your contributions align with our project standards:

• Create your pull requests against the develop branch.
• All code must be in Kotlin, following the official Kotlin coding conventions.
• Format your code using ./gradlew spotlessApply before commiting your changes.

App architecture

Lawnicons is built using Modern Android Development (MAD) practices. In particular, we use:

• Jetpack Compose with Material 3 Expressive
• Kotlin with Spotless for formatting
• Metro as the primary dependency injection framework
• Retrofit for network requests

Primary modules

The project is organized into two main Gradle modules: the app module and the svg-processor module.

• The app module contains the code for the main Android app.
• The svg-processor module is a compile-time script that handles SVG to Android vector drawable conversion and other necessary configuration files.