search

ken1000minus7 / YADA

Yet Another Diary App
MIT License
10 stars 12 forks source link

readme

YADA

Explore | Travel | Write

Join the chat at https://gitter.im/YADA_/community

Table of Contents

✨ 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
  1. Navigate to the project directory.
cd YADA
  1. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/ken1000minus7/YADA.git
  1. Check the remotes for this repository.
git remote -v
  1. 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
  1. Create a new branch(prefer a branch name that relates to your assigned issue).
git checkout -b <YOUR_BRANCH_NAME>

  1. Perform your desired changes to the code base.

  2. Check your changes.

git status
git  diff
  1. Stage your changes.
git add . <\files_that_you_made_changes>
  1. Commit your changes.
git commit -m "Commit Message"
  1. Push the committed changes in your feature branch to your remote repository.
git push -u origin <your_branch_name>

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

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

  3. 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

🛣️ Roadmap

🐛 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