https://github.com/smilewithkhushi/contactplus
An Android Application that helps you manage your contacts. Built with Kotlin, XML, Firebase on Android Studio
https://github.com/smilewithkhushi/contactplus
android-application database firebase kotlin xml
Last synced: 2 months ago
JSON representation
An Android Application that helps you manage your contacts. Built with Kotlin, XML, Firebase on Android Studio
- Host: GitHub
- URL: https://github.com/smilewithkhushi/contactplus
- Owner: smilewithkhushi
- Created: 2023-07-03T11:44:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-25T06:09:16.000Z (over 2 years ago)
- Last Synced: 2024-01-26T06:39:52.802Z (over 2 years ago)
- Topics: android-application, database, firebase, kotlin, xml
- Language: Kotlin
- Homepage:
- Size: 3.37 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://developer.android.com/studio/)).
### 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](https://git-scm.com/docs/git-add). Most IDEs make this easy for you to do, so you won't need this command line version.
Writing [good commit logs](https://chris.beams.io/posts/git-commit/) 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.