Hibi 「日々」
An app for Android designed to aid your Japanese learning through keeping a journal.
Table of Contents
- Download
- Features
- Screenshots
- Tech and Architecture
- Open Source Libraries Used
- Acknowledgments
- License
Download
Or Click Here to Go To the Latest Release
Features
- Add entries at any date and time
- Search for words through Jisho.org right from the editing screen without having to switch app
- Save new words used in an entry
- Tag entries (e.g. Holiday, Day Out, Birthday)
- Add entries to books (e.g. Trip to Tokyo 2018, Trip to Shirakawa-go 2019)
- Add locations to entries
- Add images to entries
- Search your entries based on date, content, location, tags or books
- Daily reminder to add an entry
- Ability to backup and restore your data
- Dark theme and Light theme
- Easily see entries made on this day last month, and in previous years, using the Throwback feature
Screenshots
| Main Screen | Main Screen Dark | Add Entry |
|---|---|---|
 |
 |
 |
| Search Jisho | More Info | Add New Words |
|---|---|---|
 |
 |
 |
| Add Tags | Search Entries |
|---|---|
 |
 |
Tech and Architecture
Hibi is written entirely in Kotlin and employs a single activity MVVM architecture pattern using AndroidX View Model components. The activity contains a single NavHostFragment, part of the AndroidX Navigation Components, which hosts all other fragments such as the MainScreenFragment. Each fragment observes data in a View Model which may retrieve data from various repositories and API services and properly format it for display. All business logic is handled in the View Models and fragments are kept as minimal as possible (only having code for setting up Observers, click listeners, etc...). Data is stored using a Room database and queries are provided in a DAO in the form of functions. Data is then retrieved asynchronously within repositories using Kotlin coroutines and LiveData. Kodein is used for dependency injection due to it's native support for Kotlin and it's ease of writing. API calls are made using Retrofit and then converted into Kotlin objects using Moshi. Design inspired by Material Design and implemented using Material Components for Android.
Open Source Libraries Used
Timber
Used for logging
Apache 2 License
Kodein
Used for dependency injection
MIT License
Retrofit
Used for API calls
Apache 2 License
Moshi
Used for converting API responses into Kotlin objects
Apache 2 License
Android File Picker
Used for selecting file to restore from
Apache 2 License
Android Image Picker
Used for selecting images
M PLUS Rounded 1c Bold
Used as the icon font
Open Font License
Open Sans
Used throughout the application
Apache 2 License
Google Material Design Icons
Used throughout the application
Apache 2 License
Material Design Icons
Used throughout the application
SIL Open Font License 1.1
Glide
Used for image loading and caching
Simple License Display
Used for displaying OSS licenses
MIT License
Acknowledgments
Thanks to Jisho.org for making the API used for searching up words.
Thanks to this gist for providing the basis of the sticky month headers.
License
Copyright 2020 Marc Donald
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.