ken1000minus7/yada

Yet Another Diary App

YADA

Explore | Travel | Write

Table of Contents

• About
• Contributing
• How To Contribute
• Code Of Conduct
• Roadmap
• Issues
• Figma File
• Contributors
• Support

✨ About

Yet Another Diary App created for travelers who want to write about their experiences. Customizable themes with the fusion of maps and path tracking make it all the more interesting!

🤝 Contributing

The app is open for contribution during PWOC. Start discussion in the PWOC Discord Server.

To be able to use firebase services, like authentication, you will need to register your SHA-1 keys. For that, make sure your Java's bin directory is stored in environmental variables of your PC. After that, enter this in your terminal:

keytool -list -v -keystore "c:\users\your_user_name\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android 

and replace your_user_name accordingly. You can share the SHA-1 Key with your mentor, and they will add it in Firebase console. If you face any problem in this step, make sure to contact the mentor.

🖱️ How to Contribute

If you think that you can add a new feature or want to fix a bug, we invite you to contribute to YADA and make this project better. To start contributing, follow the below instructions:

1. Create a folder at your desire location (usually at your desktop).

2. Open Git Bash Here

3. Fork the project. Click on the icon in the top right to get started.

4. Clone your forked repository of project.

git clone https://github.com/ken1000minus7/YADA.git

5. Navigate to the project directory.

cd YADA

6. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/ken1000minus7/YADA.git

7. Check the remotes for this repository.

git remote -v

8. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.

git pull upstream main

9. Create a new branch(prefer a branch name that relates to your assigned issue).

git checkout -b <YOUR_BRANCH_NAME>

10. Perform your desired changes to the code base.

11. Check your changes.

git status

git  diff

12. Stage your changes.

git add . <\files_that_you_made_changes>

13. Commit your changes.

git commit -m "Commit Message"

14. Push the committed changes in your feature branch to your remote repository.

git push -u origin <your_branch_name>

15. To create a pull request, click on compare and pull requests.

16. Add an appropriate title and description to your PR explaining your changes.

17. Click on Create pull request.

Congratulations🎉, you have made a PR to the YADA. Wait for your submission to be accepted and your PR to be merged by a maintainer.

🫴 How to Do Your First Pull Request?

(We are providing some Resource from where you can Learn)

1. Learn from Video
2. Open Source Guide

🤵 Code of Conduct

• Code of Conduct

🛣️ Roadmap

• Complete Kotlin Supremacy
• Introduction of ViewModels and implementation of MVVM architecture
• UI Overhauls

🐛 Issues

If you think you have found a bug, please report it on Issues. The app is under active development and some new features are planned. You can suggest and vote for new features in the same location.

🎨 FIGMA File

Click here

🙌 Contributors

🙏🏽 Support

This project needs a star️ from you. Don't forget to leave a star✨ Follow my Github for content

---

© ken1000minus7

yada's Issues

Fix Memorable Locations "Add a new place" multiple instances creation

video_2023-02-27_15-19-53.mp4

Whenever we open the Memorable Location screen, a new instance of Add a new place is created.

Add code of conduct

free points lol

Swipe not working for map

Map swipe not working cuz it's clashing with viewpager swipe

JAVA to Kotlin Migration : Options package

• In this issue, we will be focusing on migrating JAVA code to Kotlin in the options package :
  https://github.com/ken1000minus7/YADA/blob/2532095b161fbe73dee1114d821d463b6fd35b62/app/src/main/java/com/kamikaze/yada/options

Java to Kotlin Migration: Diary, Weather packages

• Convert the java files to kotlin in Diary and Weather packages

Fix workflow failure

Workflow is failing for some reason, check the prob and make necessary changes

Make readme more user friendly

Prerequisites

Please answer the following questions for yourself before submitting an issue.

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed

Issue Type : Adding Features

Add comprehensive steps to make it easier for first time users to contribute
Please give a brief description of the feature you want to be added

Expected Behavior

Please describe the behavior you are expecting

Current Behavior

What is the current behavior?

Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

• Firmware Version:
• Operating System:
• SDK version:
• Toolchain version:

Failure Logs

Please include any relevant log snippets or files here.

Update Landing Page/ Onboarding UI

• Update XMLs for onboarding package according to the new Figma designs
• Figma Link is in Readme.md

Add Code of Conduct md file

• Add Code of Conduct markdown file

First Issue

First Issue . Oops

Migrate Code from JAVA to Kotlin in yada package (not subpackages)

List of files to be migrated:

• FeatureFragment.java
• Feedback.java
• HikersWatchActivity.java
• MainFragmentPagerAdapter.java
• MainPageActivity.java
• MapsActivity.java
• MapsFragment.java
• MemorablePlacesActivity.java
• TranslateActivity.java

Restructuring the README.md

• I suggest restructuring the Support section to the bottom of the README
• I would like to be assigned to the issue if approved

More eye catching and pleasing button design

Prerequisites

Please answer the following questions for yourself before submitting an issue.

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed

Issue Type : Adding Features

Please give a brief description of the feature you want to be added
Add rounded corners on buttons

Expected Behavior

Please describe the behavior you are expecting

Current Behavior

What is the current behavior?

Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

• Firmware Version:
• Operating System:
• SDK version:
• Toolchain version:

Failure Logs

Please include any relevant log snippets or files here.

Add an Issue Template

• Add issue template

Add Lottie Animations

Add lottie animations in different places like when no search result found

ADD PR Template

• Add a Pull Request Template

Avoid Screen from dimming.

Prerequisites

Please answer the following questions for yourself before submitting an issue.

• I am running the latest version
• I checked the documentation and found no answer
• I checked to make sure that this issue has not already been filed

Issue Type : Adding Features

Please give a brief description of the feature you want to be added

Expected Behavior

Screen may get dimmed on not under operation by user or from any interruption in a process whenever system not responds for a time.

We need to stop this.
Please describe the behavior you are expecting

Current Behavior

What is the current behavior?

Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

• Firmware Version:
• Operating System:
• SDK version:
• Toolchain version:

Failure Logs

Please include any relevant log snippets or files here.

Improve README

Add badges for tech used
Add contributors list
Add any more stuff that would look nice

NEW UI

I suggests some new UI changes to this application , maybe some animations which will make it look trendy and cooler. Some new themes for the main page of the app too.