https://github.com/leocolman/petals
🌻 The Open Source app Petals aims to help its users to either quit weed, reduce usage or simply know how much they're using.
https://github.com/leocolman/petals
agplv3 android cannabis damage-reduction drugs hacktoberfest kotlin privacy weed
Last synced: about 1 month ago
JSON representation
🌻 The Open Source app Petals aims to help its users to either quit weed, reduce usage or simply know how much they're using.
- Host: GitHub
- URL: https://github.com/leocolman/petals
- Owner: LeoColman
- License: agpl-3.0
- Created: 2021-11-09T10:13:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:15:02.000Z (7 months ago)
- Last Synced: 2024-10-29T21:29:18.715Z (7 months ago)
- Topics: agplv3, android, cannabis, damage-reduction, drugs, hacktoberfest, kotlin, privacy, weed
- Language: Kotlin
- Homepage:
- Size: 32.2 MB
- Stars: 84
- Watchers: 4
- Forks: 33
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Petals
[](https://github.com/LeoColman/Petals/blob/main/LICENSE)
[](https://github.com/LeoColman/Petals/actions/workflows/unit-tests.yaml)
[](https://github.com/LeoColman/Petals/actions/workflows/detekt.yaml)
[](https://github.com/LeoColman/Petals/actions/workflows/dependency-analysis.yaml)
[](https://hosted.weblate.org/engage/petals-app/)
[](https://star-history.com/#LeoColman/Petals&Date)
[](https://gitmoji.dev/)
[](https://github.com/sobolevn/git-secret)
[](https://f-droid.org/packages/br.com.colman.petals/)
[](https://github.com/LeoColman/Petals/releases)
[](https://apt.izzysoft.de/fdroid/index/apk/br.com.colman.petals)
[)](https://github.com/LeoColman/Petals/releases)
[)](https://github.com/LeoColman/Petals/releases/latest)
------
The Open Source app Petals aims to help its users to either quit weed, reduce usage or simply know how much they're
using.
[
](https://github.com/LeoColman/Petals/releases)
[
](https://f-droid.org/packages/br.com.colman.petals/)
[
](https://apt.izzysoft.de/fdroid/index/apk/br.com.colman.petals)
[
](https://www.openapk.net/petals/br.com.colman.petals/)
[
](https://www.androidfreeware.net/download-petals-apk.html)
[
](https://play.google.com/store/apps/details?id=br.com.colman.petals)
### ⚠️ The Google Play Store version contains advertisements
For an ad free experience download the app from other release channels.
## 🌐 Contributing Translations
[](https://hosted.weblate.org/engage/petals-app/)
Petals welcomes community contributions for translations! To contribute translations, please follow these guidelines:
- ✨ **New Languages**: If you are adding a new language, translations must be 100% complete before submission.
- ⚠️ **Minimum Completion**: Translations that fall below 60% completion will be removed to maintain quality.
- 🤝 **Contribution Methods**:
- 🌍 Non-programmers are encouraged to collaborate via [Weblate](https://hosted.weblate.org/engage/petals-app/).
- 🖥️ Programmers may contribute translations via pull requests directly on GitHub.
[](https://hosted.weblate.org/engage/petals-app/)
Translations are hosted at Weblate. You can contribute to your language [here](https://hosted.weblate.org/engage/petals-app/).
## Screenshots
Open to see screenshots
[More Screenshots](fastlane/metadata/android/en-US/images/phoneScreenshots/)
## Building
You can assemble both debug and release versions of the app for different variants (F-Droid, Playstore, GitHub) using
the corresponding Gradle tasks. Here's how to do that:
### Debug Version
- F-Droid: `./gradlew assembleFdroidDebug`
- PlayStore: `./gradlew assemblePlaystoreDebug`
- GitHub: `./gradlew assembleGithubDebug`
### Release Version
For the release version, you must first decrypt secrets using `git secret reveal`. The release version can be assembled
as follows:
- F-Droid: `./gradlew assembleFdroidRelease`
- PlayStore: `./gradlew assemblePlaystoreRelease`
- GitHub: `./gradlew assembleGithubRelease`
## Git Secrets
The **Keystore**, **Keystore Properties**, and **Google Play deploy json** files are included in the repository using
[git secret](https://sobolevn.me/git-secret/). The current secret owners are:
- Leonardo Colman Lopes
- Fingerprint `B3A5 9909 9ECC 4DB4 FD40 896F 7706 1922 C587 2792`
- Original Author
- GitHub Actions
- Fingerprint `882E 409C 71F4 565B 1698 B947 A992 5FF4 75B3 5E07`
- Auto-publishing signed app to GitHub
- Expires on 2027-04-05
- Available on environment secret `GPG_KEY`
## Releasing
Release to all our channels is made automatically after a tag is released. The workflow responsible for doing this
is [release.main.kts](.github/workflows/release.main.kts).
### Google Play Store
1. Decrypt all git secrets
2. Run `./gradlew bundlePlaystoreRelease`
3. Publish to playstore by running
`cd fastlane && bundle config path vendor/bundle && bundle install --jobs 4 --retry 3 && bundle exec fastlane playstore`
### F-Droid
F-Droid builds automatically from the repository whenever a new tag is published. The definitions for how to build the
app are
in [F-Droid's data repository](https://gitlab.com/fdroid/fdroiddata/-/blob/master/metadata/br.com.colman.petals.yml). If
modifications are required, the place to change is there.
### Releases Page
1. Decrypt all git secrets
2. Run `./gradlew assembleGithubRelease`