Skip to content

Latest commit

 

History

History
246 lines (168 loc) · 9.22 KB

README.md

File metadata and controls

246 lines (168 loc) · 9.22 KB
Raw

Git-Finder

GitFinder Poster

Table of Contents

📌 Open Source Program

This project is now OFFICIALLY accepted for

GSSOC-EXT HACKTOBERFEST

About Git-Finder

GitHub Finder is a social platform that leverages GitHub authentication to provide users with a space to share their thoughts, ideas, and insights with the developer community. Users can post updates, interact with others, and explore GitHub profiles of fellow users.

Tech-Stack

React Firebase taiwindcss

Features

1. GitHub Authentication

  • Users can log in securely using their GitHub credentials.
  • OAuth integration ensures a seamless and secure authentication process.

2. Post Thoughts

  • Share your latest discoveries, thoughts, or challenges with the community.
  • Post updates in a format similar to popular social media platforms.

3. Explore GitHub Profiles

  • Search for other GitHub users and explore their profiles.
  • View GitHub contribution graphs to understand their coding activity over time.
  • Explore repositories and projects associated with each user.

4. Connect with Developers

  • Follow other GitHub users to stay updated on their activities.
  • Like, comment, and engage with posts to foster a vibrant developer community.

Whether you're looking to build your professional network, seek feedback on projects, or simply stay in touch with fellow coders, GitHub Finder creates an engaging space for developers of all levels.

What can you contribute?

How to contribute?

  • Drop a Star in this repo
  • Take a look at the existing Issues.
  • Fork the Repo create a branch for any issue that you are working on and commit your work.
  • At first raise an issue in which you want to work
  • Please do not make more than 2 issues at a time , Once your PR have been merged only then go for the next issue
  • Then when you are get assigned only then work on that issue & make a PR
  • Please try to make a separate branch in your fork in case of PR
  • Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
  • REMINDER: Commit inside the Projects Folder
  • Find the already Existing Projects in the Projects Folder
  • Add screenshots or video prototypes to your Pull Request to help us understand the effects of the changes that are included in your commits.

Installation and Setup

Prerequisites

  • Node.js
  • npm

Steps

  1. Clone the repository:

    git clone https://github.com/<your-github-username>/GitFinder.git

  2. Navigate to the project directory:

    cd GitFinder

  3. Install Dependencies:

    npm install

  4. Run the project:

    npm run dev

  5. Contribution Guidelines Move detailed steps to a new CONTRIBUTING.md file and link to it:

Back To Top

How to make a Pull Request?

1. Start by forking the GitFinder repository. Click on the symbol at the top right corner.

2. Clone your forked repository:

git clone https://github.com/<your-github-username>/GitFinder

3. Navigate to the new project directory:

cd GitFinder

4. Set upstream command:

git remote add upstream https://github.com/BamaCharanChhandogi/GitFinder

5. Create a new branch:

git checkout -b YourBranchName

or

git branch YourBranchName
git switch YourBranchName

6. Sync your fork or local repository with the origin repository:

  • In your forked repository click on Fetch upstream.
  • Click Fetch and merge.

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

Github Docs for Syncing

Read the documentation

7. Make your changes to the source code.

8. Stage your changes and commit:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

git add file/folder
git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

Congratulations! You've made your first contribution! 🙌🏼

Back To Top

Project Contributors

License


Show some ❤️  by giving to this repo

Back To Top