?EasyLinks?
An Open Source App which enables users to drop all their professional handles and projects at one place. This is a Beginner Friendly Repository made for Open Source Enthusiasts who can contribute to the App during HacktoberFest 2021.
Features✨
- User can share their various platforms’ handles.
- User can add their projects with heading and description.
- User can search other user’s profile.
- User can get a shareable link for their profiles.
Tech to be used?️
- Android SDK
- Kotlin
- Firebase
- Deep linking
Set up and contribute in EasyLinks⚙️
1. Star and Fork this Repository
You can star ⭐ and fork ?️ this repository on GitHub by navigating at the top of this repository.
GitHub repository URLs will reference both the username associated with the owner of the repository, as well as the repository name. For example, DSC-JSS-NOIDA is the owner of this repository, so the GitHub URL for this project is:
https://github.com/DSC-JSS-NOIDA/EasyLinks
When you’re on the main page for the repository, you’ll see a button to “Star” and “Fork” the repository on your upper right-hand side of the page, underneath your user icon.
2. Clone the Repository
To make your own local copy of the repository you would like to contribute to, let’s first open up a terminal window.
We’ll use the git clone command along with the URL that points to your fork of the repository.
This URL will be similar to the URL above, except now it will end with .git. In the example above, the URL will look like this:
https://github.com/your-username/EasyLinks.git
You can alternatively copy the URL by using the green “Clone or download” button from your repository page that you just forked from the original repository page. Once you click the button, you’ll be able to copy the URL by clicking the binder button next to the URL:
Once we have the URL, we’re ready to clone the repository. To do this, we’ll combine the git clone command with the repository URL from the command line in a terminal window:
git clone https://github.com/your-username/EasyLinks.git
3. Download Android Studio
Link to Developers page: https://developer.android.com/studio
4. Open the Project
After completing the setup for Android Studio open the project.
5. Create New Branch
Once the project is opened create a new branch and checkout in it where you can make the changes in the code.
You can do this either from terminal or Directly in Android Studio.
To do from Terminal:
git branch new-branch
git checkout new-branch
To do directly from Android Studio
Click on Git branch in the bottom-right corner in Android Studio and create a new branch from there and checkout to it.
6. Commit and Push
After making the required changes commit and push your code
Terminal:
To add the changes after you have made the modifications
git add . or git add -A
To commit and push the changes
git commit -m <Your-commit-message>
git push --set-upstream origin new-branch
From Android Studio:
7. Update Local Repository
While working on a project alongside other contributors, it is important for you to keep your local repository up-to-date with the project as you don’t want to make a pull request for code that will cause conflicts. To keep your local copy of the code base updated, you’ll need to sync changes.
We’ll first go over configuring a remote for the fork, then syncing the fork.
8. Configure a Remote for the Fork
You’ll have to specify a new remote upstream repository for us to sync with the fork. This will be the original repository that you forked from. you’ll have to do this with the git remote add command.
git remote add upstream https://github.com/DSC-JSS-NOIDA/EasyLinks
In this example, // upstream // is the shortname we have supplied for the remote repository since in terms of Git, “upstream” refers to the repository that you cloned from. If you want to add a remote pointer to the repository of a collaborator, you may want to provide that collaborator’s username or a shortened nickname for the shortname.
9. Sync the Fork
Once you have configured a remote that references the upstream and original repository on GitHub, you are ready to sync your fork of the repository to keep it up-to-date.
To sync your fork, from the directory of your local repository in a terminal window, you’ll have to use the // git fetch // command to fetch the branches along with their respective commits from the upstream repository. Since you used the shortname “upstream” to refer to the upstream repository, you’ll have to pass that to the command:
git fetch upstream
Switch to the local master branch of our repository:
git checkout master
Now merge any changes that were made in the original repository’s master branch, that you will access through your local upstream/master branch, with your local master branch:
git merge upstream/master
10. Create Pull Request
At this point, you are ready to make a pull request to the original repository.
Now navigate to your forked repository, and press the “New pull request” button on your left-hand side of the page.
Want to improve it ✨? Feel free to contribute??
Built with ❤️ by Google Developer Student Club JSS
Need help? Feel free to contact us @ [email protected]
Connect with us
This project follows the all-contributors specification. Contributions of any kind welcome!
