Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alisonthemonster/Presently
Android app for recording gratitude journal entries -- over 1 million installs, contribute today!
https://github.com/alisonthemonster/Presently
android architecture-components circleci dropbox-sdk firebase firebase-test-lab hacktoberfest hilt instrumented-tests jacoco kotlin mavericks mobile room room-persistence-library
Last synced: 3 months ago
JSON representation
Android app for recording gratitude journal entries -- over 1 million installs, contribute today!
- Host: GitHub
- URL: https://github.com/alisonthemonster/Presently
- Owner: alisonthemonster
- Created: 2018-12-22T20:35:39.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-02-05T13:25:45.000Z (9 months ago)
- Last Synced: 2024-06-25T09:40:44.675Z (5 months ago)
- Topics: android, architecture-components, circleci, dropbox-sdk, firebase, firebase-test-lab, hacktoberfest, hilt, instrumented-tests, jacoco, kotlin, mavericks, mobile, room, room-persistence-library
- Language: Kotlin
- Homepage:
- Size: 3.8 MB
- Stars: 381
- Watchers: 14
- Forks: 80
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-android-kotlin-apps - Presently - - over 1 million installs, contribute today!</br></br> <b>Tech Stack</b> : Dagger, Coroutines, RxJava, Testing, Room, Firebase Messaging, WorkManager, Dropbox, Calendar view, Paging, Biometric, LiveData, ViewModel </br></br> <i> Last commit: 5 months ago</i> | 🌟 348 </br> 🍴 75 </br> 👁️ 14 | (:art: Pattern / MVVM)
README
# Presently: A Gratitude Journal
[](https://circleci.com/gh/alisonthemonster/Presently/tree/develop)
A journal to write what you're thankful for. Contributions welcome!
[Google Play Posting](https://play.google.com/store/apps/details?id=journal.gratitude.com.gratitudejournal&hl=en)
### Philosophy
Presently is built on the idea that gratitude journaling should be free, private, and available to all. It will never have ads, never have a premium version, and will always be open source. Entries are kept on device and can be exported to CSV.
Presently is also built with the best Android practices in mind. It follows MVVM to separate concerns and ensure we write testable code. We require 80%+ code coverage and rely on both unit tests and instrumented tests (with a heavier weight towards unit tests). Instrumented tests are run on Firebase Test Lab, crashes are reported through Crashlytics, and analytics are reported with Firebase Analytics.
We support several languages currently and are always looking for translators to help us! We support French, Spanish, Italian, German, Finnish, Arabic, Dutch, Polish, Portuguese, Slovakian, Croatian, Romanian, Turkish, Russian, Afrikaans.
### Tech Stack [So far...]
- MVVM with architecture components
- ViewModel
- Room (with FTS and Paging v3)
- Mavericks
- CircleCI
- Jacoco coverage reports (integrated with CI)
- Firebase Crashlytics Crash Reporting
- Dagger + Hilt
- Espresso
- Firebase Test Lab
- WorkManager
- Dropbox Java SDK
## Design
The app currently has over 40 themes to choose from! Here's a few:
### Contributions
Contributions are welcome! Please fork the repo and make a PR. Forked PRs will build the app and run unit tests but will not run instrumented tests. A repo owner will run those tests as they require secret keys. To make the app build locally you'll need to add a Dropbox Key (or any string if you don't want to test Dropbox backup features) to the `local.properties` file. Like so: `DROPBOX_KEY=myDropboxKey`.
### Dependency Graph
Presently is a small and simple app, did it need modularizing? Probably not. But Presently also servees as a playground for me for trying out new technologies and keeping up with best practices. Here's how we've broken down the app so far.
