Skip to content
This repository has been archived by the owner on May 17, 2023. It is now read-only.

Commit

Permalink
Merge pull request #29 from MarcDonald/version/1.2.0
Browse files Browse the repository at this point in the history
Version 1.2.0
  • Loading branch information
MarcDonald authored Jun 26, 2019
2 parents c9a292c + 6546956 commit 4dd515f
Show file tree
Hide file tree
Showing 240 changed files with 2,584 additions and 1,135 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Device (please complete the following information):**
- Device: [e.g. Samsung S10+]
- App Version (e.g. 1.4.0)
- Android Version [e.g. Pie]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[REQUEST] "
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Binary file removed .github/assets/add-entry-dark.png
Binary file not shown.
Binary file added .github/assets/add-entry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/assets/add-tags-dark.png
Binary file not shown.
Binary file added .github/assets/add-tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/add-words.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/main-display-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/main-display-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/assets/new-word-dark.png
Binary file not shown.
Binary file removed .github/assets/search-entries-dark.png
Binary file not shown.
Binary file added .github/assets/search-entries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/assets/search-jisho-dark.png
Binary file not shown.
Binary file added .github/assets/search-jisho-more.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/search-jisho.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/assets/view-entry-dark.png
Binary file not shown.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,23 @@ An app for Android designed to aid your Japanese learning through keeping a jour
- 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
- Dark theme and Light theme

## Screenshots
| Main Screen | Main Screen Dark | Add Entry |
|:-:|:-:|:-:|
| ![Main Screen](/.github/assets/main-display-light.png?raw=true) | ![Dark Theme](/.github/assets/main-display-dark.png?raw=true) |![Add entry](/.github/assets/add-entry-dark.png?raw=true)
| ![Main Screen](/.github/assets/main-display-light.png?raw=true) | ![Dark Theme](/.github/assets/main-display-dark.png?raw=true) |![Add entry](/.github/assets/add-entry.png?raw=true)

| Search Jisho | Add Tags | Add New Words |
| Search Jisho | More Info | Add New Words |
|:-:|:-:|:-:|
| ![Search Jisho](/.github/assets/search-jisho-dark.png?raw=true) | ![Add Tags](/.github/assets/add-tags-dark.png?raw=true) | ![Add New Words](/.github/assets/new-word-dark.png?raw=true)
| ![Search Jisho](/.github/assets/search-jisho.png?raw=true) | ![More Info](/.github/assets/search-jisho-more.png?raw=true) | ![Add New Words](/.github/assets/add-words.png?raw=true)

| Search Entries | View Entry |
| Add Tags | Search Entries |
|:-:|:-:|
| ![Search Entries](/.github/assets/search-entries-dark.png?raw=true) | ![View Entry](/.github/assets/view-entry-dark.png?raw=true) |
| ![Add Tags](/.github/assets/add-tags.png?raw=true) | ![Search Entries](/.github/assets/search-entries.png?raw=true) |

## Tech and Architecture
Written in Kotlin and employing an MVVM architecture pattern using [AndroidX View Model](https://developer.android.com/topic/libraries/architecture/viewmodel) components. Navigation is handled by the [AndroidX Navigation Components](https://developer.android.com/guide/navigation/). Data is stored using a [Room](https://developer.android.com/jetpack/androidx/releases/room) database and then retrieved asynchronously using Kotlin coroutines and [LiveData](https://developer.android.com/topic/libraries/architecture/livedata). [Kodein](https://github.com/Kodein-Framework/Kodein-DI) 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](https://github.com/square/retrofit) and then converted into Kotlin objects using [Gson](https://github.com/google/gson). Design inspired by [Material Design](https://material.io/) and implemented using [Material Components for Android](https://github.com/material-components/material-components-android).
Hibi is written entirely in Kotlin and employs an MVVM architecture pattern using [AndroidX View Model](https://developer.android.com/topic/libraries/architecture/viewmodel) components. Navigation is handled by the [AndroidX Navigation Components](https://developer.android.com/guide/navigation/). Data is stored using a [Room](https://developer.android.com/jetpack/androidx/releases/room) database and then retrieved asynchronously using Kotlin coroutines and [LiveData](https://developer.android.com/topic/libraries/architecture/livedata). [Kodein](https://github.com/Kodein-Framework/Kodein-DI) 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](https://github.com/square/retrofit) and then converted into Kotlin objects using [Gson](https://github.com/google/gson). Design inspired by [Material Design](https://material.io/) and implemented using [Material Components for Android](https://github.com/material-components/material-components-android).

## Open Source Libraries Used
### [Timber](https://github.com/JakeWharton/timber)
Expand Down
6 changes: 3 additions & 3 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ apply plugin: 'androidx.navigation.safeargs'
android {
compileSdkVersion 28
defaultConfig {
applicationId "app.marcdev.hibi"
applicationId "com.marcdonald.hibi"
minSdkVersion 23
targetSdkVersion 28
versionCode 28
versionName "1.1.0"
versionCode 29
versionName "1.2.0"
setProperty("archivesBaseName", "Hibi-v$versionName")
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
Expand Down
16 changes: 7 additions & 9 deletions app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="app.marcdev.hibi">
package="com.marcdonald.hibi">

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.SET_ALARM" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<application
android:name="app.marcdev.hibi.Hibi"
android:name=".Hibi"
tools:replace="android:allowBackup"
android:allowBackup="false"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="true"
android:theme="@style/AppTheme.Light"
android:theme="@style/AppTheme.Dark"
tools:ignore="GoogleAppIndexingWarning">
<activity
android:name="app.marcdev.hibi.MainActivity"
android:name=".MainActivity"
android:windowSoftInputMode="adjustResize">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
Expand All @@ -29,13 +29,12 @@
android:name="android.app.shortcuts"
android:resource="@xml/shortcuts" />
</activity>
<activity android:name=".maintabs.settings.OpenSourceLicencesActivity" />
<activity android:name=".maintabs.settings.AboutActivity" />
<activity android:name=".maintabs.settings.SettingsActivity" />
<activity android:name=".mainscreens.about.OpenSourceLicencesFragment" />
<activity android:name=".mainscreens.settings.SettingsFragment" />

<receiver android:name=".internal.notification.AlertReceiver" />
<provider
android:authorities="app.marcdev.hibi.FileProvider"
android:authorities="com.marcdonald.hibi.FileProvider"
android:name="androidx.core.content.FileProvider"
android:enabled="true"
android:grantUriPermissions="true"
Expand All @@ -45,5 +44,4 @@
android:resource="@xml/filepaths" />
</provider>
</application>

</manifest>
Binary file modified app/src/main/ic_launcher-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 4dd515f

Please sign in to comment.