Skip to content

GitFind is a project that uses the Github API to provide information and insights about a Github user profile. It shows the date the user joined Github, events related to their account, who they follow, information about their repositories, and the prominent language used in each repository. The project is made using React and Tailwind.

Notifications You must be signed in to change notification settings

Pranshu321/Git-Find

Repository files navigation


Logo

Git Find

An awesome tool to explore the world of github!
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Contact
  5. Acknowledgments

About The Project

image

A project that uses the Github API to provide insights about a GitHub profile. With this project, you can see the date a user joined Github, events related to their account, who they follow, and information about their repositories.

Here's why:

  • Repository Details: GitFind offers in-depth information about the repositories associated with a Github profile. Users can gain insights into the repository's details, including its name, description, and the prominent programming language used in each repository. This feature helps users understand the user's areas of expertise and the types of projects they are involved in, facilitating potential collaborations or identifying repositories of interest for further exploration.

  • Following Analysis: GitFind allows users to explore the users that a particular Github profile follows. This feature provides valuable information about the user's network and connections within the Github community. Users can discover influential developers, projects, or organizations that the profile owner finds interesting or relevant, fostering collaboration and knowledge-sharing opportunities.

  • Profile Insights: GitFind utilizes the Github API to provide valuable insights about a user's profile. It allows users to view the date a user joined Github, events related to their account, and information about their repositories. This feature enables users to gain a comprehensive understanding of a user's activity and history on the platform.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap in project.

React Vue Vue Vue

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can install and setting up your app local version.

  1. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  2. Install NPM packages
    npm install
  3. Enter vite dev command to run project``
    npm run dev
  4. Hurray!!! you can see project live on http://localhost:4173 or http://localhost:3000

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Previous Examples and commits

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Your Name - Pranshu Jain - pranshujain0111@gmail.com

Project Link: https://github.com/pranshu321/Git-Find

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

GitFind is a project that uses the Github API to provide information and insights about a Github user profile. It shows the date the user joined Github, events related to their account, who they follow, information about their repositories, and the prominent language used in each repository. The project is made using React and Tailwind.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published