Skip to content

An Android Application that helps you manage your contacts. Built with Kotlin, XML, Firebase on Android Studio

Notifications You must be signed in to change notification settings

smilewithkhushi/ContactPlus

Repository files navigation

ContactPlus

An Android Application that helps you manage your contacts.

🛠️ Tech Stack 🛠️

  • Kotlin
  • XML
  • Firebase Authentication
  • Firebase Realtime Database

📲 Preview 📲

Welcome Screen Login Screen Sign Up Screen Dashboard Add New Contacts

💭 Prerequisites 💭

System requirements

  1. Any system with basic configuration.
  2. Operating System: Windows / Linux / Mac

Software requirements

  1. Android Studio (If not, download it here).

Skill requirement

  • Basic Knowledge of Git & GitHub.
  • Familiar with Kotlin
  • Java
  • XML

🧑‍💻 Contributing 🧑‍💻

Setting up a local environment

Forking repository

  1. Firstly to make your copy of the project you have to fork the repository. To fork the repository, press the fork button.

Clone repository

  1. Now after you have forked the project, it's time to clone it into your local device so that you can work properly.
  2. In your forked repository click on the green code button and copy the provided link.
  3. Now on your desktop open Git Bash and type git clone https://github.com/yourusername/ContactPlus.git, and press enter
  4. Now, your forked repository has been cloned in your device! 🎉

Create a Branch for your feature

Make sure your fork is up-to-date and create a topic branch for your feature or bug fix. (The name my-feature-branch is an example. Choose whatever you like.)

git checkout main
git remote add upstream https://github.com/SmileWithKhushi/ContactPlus.git
git pull upstream main
git checkout -b my-feature-branch

Build and Test

Ensure that you can build the project and run it on your mobile device before you create a pull request.

Write Code

Implement your feature or bug fix.

Make sure that your app builds and is successfully installed on your mobile device without errors.

Commit Changes

Make sure git knows your name and email address:

git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"

Add the changed files to the index using git add. Most IDEs make this easy for you to do, so you won't need this command line version. Writing good commit logs is important. A commit log should describe what changed and why.

git add ...
git commit -m "Fixed Foo bug by changing bar"

Push to your GitHub repository

git push origin my-feature-branch

Make a Pull Request

Go to https://github.com/yournamehere/ContactPlus and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.

If code review requests changes (and it usually will) just git push the changes to your repository on the same branch, and the pull request will be automatically updated.

Rebase

If you've been working on a change for a while and other commits have been made to the project, rebase with upstream/master.

git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f

Check on Your Pull Request

Go back to your pull request after a few minutes/days and see whether it passed the code-review Everything should be fine if your PR is green ✅ and successfully merged or code changes will be requested by the maintainers.


Make sure you ⭐ the repository if you liked this project!

About

An Android Application that helps you manage your contacts. Built with Kotlin, XML, Firebase on Android Studio

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages