treklogue

Treklogue - Travel journalling app that brings your memories back to paradise.

https://github.com/mingyuliuu/treklogue

Science Score: 18.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.6%) to scientific vocabulary

Keywords

android jetpack-compose kotlin
Last synced: 6 months ago · JSON representation ·

Repository

Treklogue - Travel journalling app that brings your memories back to paradise.

Basic Info
  • Host: GitHub
  • Owner: mingyuliuu
  • Language: Kotlin
  • Default Branch: main
  • Homepage:
  • Size: 9.76 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Topics
android jetpack-compose kotlin
Created about 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Citation

README.md

cs446-group18

Group Members:

| Name | Quest ID | Github Username | | ------------- | ---------| --------------- | | Mingyu Liu | 20832269 | mingyuliuu | | Alice Wang | 20823650 | alicewangzm | | Danyang Wang | 20882639 | danyang0108 | | Michael Huang | 20898233 | hlxmh | | Kelly Shen | 20873010 | kellyyys | | Yingjia Zhang | 20876108 | Yingjia-Z |

Treklogue

Treklogue is a travelling journal that allows users to "check in" at landmarks. Users are only allowed to check in when they are close to the landmark. They can write a short description of how they are feeling at the moment and upload any pictures they took from the landmark.

Gallery

Login Page and Terms and Conditions

Main Screen

Profile Page

Instructions

Treklogue uses Google Places APIs and Firebase. You need to setup those two apis in order for it to function.
Firebase Setup:
You will need a google-services.json file with an API key from our database. Please ask for one when testing the app.
Google API Setup:
Please set up an API key in Google with the Maps SDK for Android and Google Places APIs enabled. Afterwards, create a local.properties in the root of the project with the lines:
sdk.dir={your SDK directory} MAPS_API_KEY={your API key}

Built with

Owner

  • Name: Miranda
  • Login: mingyuliuu
  • Kind: user
  • Company: @uWaterloo

Citation (citations.md)

* Clean Architecture starter code: https://git.uwaterloo.ca/cs346/public/1241/slides/-/tree/main/06-04-ui-patterns/clean-android-ui
* Template app provided by MongoDB Atlas: https://www.mongodb.com/docs/atlas/app-services/reference/template-apps/#std-label-template-apps
* Maps Compose Library: https://developers.google.com/maps/documentation/android-sdk/maps-compose
* Distance function:  https://mapsplatform.google.com/resources/blog/how-calculate-distances-map-maps-javascript-api/
* Custom MapMarker from drawable icons: https://www.boltuix.com/2022/11/add-custom-marker-to-google-maps-in.html
* Tutorial on using Hilt and Firebase auth: https://www.simplifiedcoding.net/firebase-authentication-using-mvvm/
* FirestoreCleanArchitectureApp: https://github.com/alexmamo/FirestoreCleanArchitectureApp
* NotificationServices: https://github.com/android/user-interface-samples/blob/main/People/app/src/main/java/com/example/android/people/data/NotificationHelper.kt
* Uploading images to Firebase storage: 
  * https://www.youtube.com/watch?v=btfGTDeZg8w
  * https://firebase.google.com/docs/storage/android/upload-files

#### Assets
* All custom markers are drawn based on: https://www.flaticon.com/free-icon/destination_3295084?related_id=3295084&origin=pack

#### Styling
* Material 3 Design Kit: https://www.figma.com/file/Sv5kmFfe0EptMZwXBhhq5K/Material-3-Design-Kit-(Community)?type=design&node-id=50732-11342&mode=design&t=Mxh9Gmu4GH2s3vID-0

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: almost 2 years ago

All Time
  • Total issues: 44
  • Total pull requests: 20
  • Average time to close issues: 15 days
  • Average time to close pull requests: about 13 hours
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.64
  • Average comments per pull request: 0.0
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 44
  • Pull requests: 20
  • Average time to close issues: 15 days
  • Average time to close pull requests: about 13 hours
  • Issue authors: 4
  • Pull request authors: 4
  • Average comments per issue: 0.64
  • Average comments per pull request: 0.0
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mingyuliuu (16)
  • hlxmh (10)
  • Kellyyys (9)
  • danyang0108 (1)
Pull Request Authors
  • mingyuliuu (12)
  • hlxmh (5)
  • Kellyyys (5)
  • Yingjia-Z (3)
Top Labels
Issue Labels
high priority (7)
Pull Request Labels

Dependencies

app/build.gradle.kts maven
  • androidx.activity:activity-compose 1.8.2 implementation
  • androidx.appcompat:appcompat 1.5.1 implementation
  • androidx.compose.foundation:foundation 1.3.1 implementation
  • androidx.compose.material3:material3 * implementation
  • androidx.compose.runtime:runtime-livedata 1.3.2 implementation
  • androidx.compose.ui:ui * implementation
  • androidx.compose.ui:ui-graphics * implementation
  • androidx.compose.ui:ui-tooling-preview * implementation
  • androidx.constraintlayout:constraintlayout 2.1.4 implementation
  • androidx.core:core-ktx 1.12.0 implementation
  • androidx.lifecycle:lifecycle-runtime-ktx 2.6.2 implementation
  • androidx.lifecycle:lifecycle-viewmodel-compose 2.5.1 implementation
  • androidx.lifecycle:lifecycle-viewmodel-ktx 2.5.1 implementation
  • androidx.navigation:navigation-compose 2.7.7 implementation
  • com.google.android.gms:play-services-maps 18.2.0 implementation
  • com.google.android.material:material 1.7.0 implementation
  • com.google.maps.android:maps-compose 2.15.0 implementation
  • io.realm.kotlin:library-sync 1.11.0 implementation
  • org.jetbrains.kotlinx:kotlinx-coroutines-core 1.7.0 implementation
  • junit:junit 4.13.2 testImplementation
build.gradle.kts maven