https://github.com/green-code-initiative/ecocode-kotlin-android
Reduce the environmental footprint of your Kotlin-based Android apps with SonarQube
https://github.com/green-code-initiative/ecocode-kotlin-android
android ecodesign native sonarqube sonarqube-plugin
Last synced: about 1 month ago
JSON representation
Reduce the environmental footprint of your Kotlin-based Android apps with SonarQube
- Host: GitHub
- URL: https://github.com/green-code-initiative/ecocode-kotlin-android
- Owner: green-code-initiative
- License: lgpl-3.0
- Created: 2023-11-23T14:48:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-31T10:08:40.000Z (12 months ago)
- Last Synced: 2024-06-11T19:00:27.904Z (11 months ago)
- Topics: android, ecodesign, native, sonarqube, sonarqube-plugin
- Language: Kotlin
- Homepage: https://ecocode.io
- Size: 461 KB
- Stars: 2
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
======================================
Mobile apps running on top of battery-limited, android-powered devices are more than others concerned by the reduction
of their environmental footprint. Hence, we created `ecoCode android for Kotlin`, the version of ecoCode project fully
dedicated to the Android Kotlin projects.
It provides static code analyzers to highlight code structures that may have a negative ecological impact: energy over-consumption,
"fatware", shortening devices' lifespan, etc.
ecoCode android for Kotlin is based on an evolving catalog of [best practices for Android](https://github.com/cnumr/best-practices-mobile#-android-platform).
A SonarQube plugin then implements this catalog as rules for scanning your native Android projects.
To work on Android projects developed in Java, you can use the [ecoCode Android plugin for Java projects](https://github.com/green-code-initiative/ecoCode-android).
This project is based on [SonarSource - sonar-kotlin project](https://github.com/SonarSource/sonar-kotlin), fork of the version of the 2023/07/03.
[](https://www.gnu.org/licenses/gpl-3.0)
🚀 Quickstart
-------------
To build the project and run the test simply launch:
```bash
./gradlew build
```
Then, a docker file is configured to launch a SonarQube instance with the plugin installed:
```bash
docker compose up --build -d
```
Wait a little bit during first start initialization, and go to [http://localhost:9000](http://localhost:9000). Default credentials are `admin`/`admin`
🧩 Plugins version compatibility
------------------
| Plugins Version | SonarQube version |
|-----------------|-----------------------------|
| 0.0.+ | SonarQube 9.9.+ LTS to 10.3 |