- Participate here and start answering questions.
- File GitHub issues for bug reports from /c/Jerboa. Watch the project for duplicate reports and link them to the first report so devs can easily close dupes.
- File new bug reports for issues you find.
- Add missing translations
- Code contributions
- Basic Modern Android Development tech stack (Compose, Navigation, Coroutines, AndroidX)
- Guide to App Architecture, without domain layer. Basically, MVVM + Repositories for data access.
- Manual DI
You can open Jerboa in AndroidStudio, version 2022.3.1 or later (Giraffe).
Use Java 11+, preferably Java 17
This project is full Kotlin. Please do not write Java classes.
The code must be formatted to a common standard.
To check for violations
./gradlew lintKotlin
Or just run this to fix them
./gradlew formatKotlin
Markdown and yaml files are formatted according to prettier.
You can install prettier either through the plugin, or globally using npm npm install -g prettier
To check for violations
prettier -c "*.md" "*.yml"
To fix the violations
prettier --write "*.md" "*.yml"
You can find the translations in the app/src/main/res/values-{locale}/strings.xml
file.
You can open it in android studio, right click and click open translations editor or you can
directly edit the files.
If you add a new locale. Also add it in locales_config.xml
. Don't forget to escape '
in translations.
There is a custom gradle task that generates all the lemmy instances that this app directly supports. It updates the lemmy instances list in DefaultInstances.kt and the AndroidManifest. It uses the fediverse api and filters on the monthly users. You can run it by doing
./gradlew app:updateInstances
You can generate the compose compiler metrics by executing the following gradle task.
./gradlew assembleRelease --rerun-tasks -P com.jerboa.enableComposeCompilerReports=true
Then you will find the metrics in app/build/compose_metrics
directory.
See this link for more information on these metrics
If you add a migration to the DB, test it with this gradle task
./gradlew app:connectAndroidTest